godot/doc/tools/makedoku.py

500 lines
13 KiB
Python
Raw Normal View History

#!/usr/bin/env python
# -*- coding: utf-8 -*-
2014-02-10 01:10:30 +00:00
import sys
import xml.etree.ElementTree as ET
input_list = []
for arg in sys.argv[1:]:
input_list.append(arg)
2014-02-10 01:10:30 +00:00
if len(input_list) < 1:
print("usage: makedoku.py <classes.xml>")
sys.exit(0)
2014-02-10 01:10:30 +00:00
def validate_tag(elem, tag):
if (elem.tag != tag):
print("Tag mismatch, expected '" + tag + "', got " + elem.tag);
sys.exit(255)
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
class_names = []
classes = {}
2014-02-10 01:10:30 +00:00
def make_class_list(class_list, columns):
2016-04-02 18:26:12 +00:00
f = open("class_list.txt", "wb")
prev = 0
col_max = len(class_list) / columns + 1
print("col max is ", col_max)
col_count = 0
row_count = 0
last_initial = ""
fit_columns = []
2016-04-02 18:26:12 +00:00
for n in range(0, columns):
fit_columns += [[]]
2014-02-10 01:10:30 +00:00
indexers = []
last_initial = ""
2016-04-02 18:26:12 +00:00
idx = 0
for n in class_list:
col = idx / col_max
if (col >= columns):
col = columns - 1
fit_columns[col] += [n]
idx += 1
if (n[:1] != last_initial):
indexers += [n]
last_initial = n[:1]
2016-04-02 18:26:12 +00:00
row_max = 0
2016-04-02 18:26:12 +00:00
for n in range(0, columns):
if (len(fit_columns[n]) > row_max):
row_max = len(fit_columns[n])
2016-04-02 18:26:12 +00:00
for r in range(0, row_max):
s = "|"
for c in range(0, columns):
if (r >= len(fit_columns[c])):
continue
2016-04-02 18:26:12 +00:00
classname = fit_columns[c][r]
initial = classname[0]
if (classname in indexers):
s += "**" + initial + "**|"
else:
s += " |"
2016-04-02 18:26:12 +00:00
s += "[[" + classname.lower() + "|" + classname + "]]|"
2016-04-02 18:26:12 +00:00
s += "\n"
f.write(s)
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
def dokuize_text(txt):
2016-04-02 18:26:12 +00:00
return txt
2014-02-10 01:10:30 +00:00
def dokuize_text(text):
pos = 0
while(True):
pos = text.find("[", pos)
if (pos == -1):
break
endq_pos = text.find("]", pos + 1)
if (endq_pos == -1):
break
pre_text = text[:pos]
post_text = text[endq_pos + 1:]
tag_text = text[pos + 1:endq_pos]
if (tag_text in class_names):
tag_text = "[[" + tag_text.lower() + "|" + tag_text + "]]"
else: # command
cmd = tag_text
space_pos = tag_text.find(" ")
if (cmd.find("html") == 0):
cmd = tag_text[:space_pos]
param = tag_text[space_pos + 1:]
tag_text = "<" + param + ">"
elif(cmd.find("method") == 0):
cmd = tag_text[:space_pos]
param = tag_text[space_pos + 1:]
if (param.find(".") != -1):
class_param, method_param = param.split(".")
tag_text = "[[" + class_param.lower() + "#" + method_param + "|" + class_param + '.' + method_param + "]]"
else:
tag_text = "[[#" + param + "|" + param + "]]"
elif (cmd.find("image=") == 0):
tag_text = "{{" + cmd[6:] + "}}"
elif (cmd.find("url=") == 0):
tag_text = "[[" + cmd[4:] + "|"
elif (cmd == "/url"):
tag_text = "]]>"
elif (cmd == "center"):
tag_text = ""
elif (cmd == "/center"):
tag_text = ""
elif (cmd == "br"):
tag_text = "\\\\\n"
elif (cmd == "i" or cmd == "/i"):
tag_text = "//"
elif (cmd == "b" or cmd == "/b"):
tag_text = "**"
elif (cmd == "u" or cmd == "/u"):
tag_text = "__"
else:
tag_text = "[" + tag_text + "]"
text = pre_text + tag_text + post_text
pos = len(pre_text) + len(tag_text)
#tnode = ET.SubElement(parent,"div")
# tnode.text=text
return text
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
def make_type(t):
global class_names
if (t in class_names):
return "[[" + t.lower() + "|" + t + "]]"
return t
2016-04-02 18:26:12 +00:00
def make_method(f, name, m, declare, event=False):
2016-04-02 18:26:12 +00:00
s = " * "
ret_type = "void"
args = list(m)
mdata = {}
mdata["argidx"] = []
for a in args:
if (a.tag == "return"):
idx = -1
elif (a.tag == "argument"):
idx = int(a.attrib["index"])
else:
continue
mdata["argidx"].append(idx)
mdata[idx] = a
if (not event):
if (-1 in mdata["argidx"]):
s += make_type(mdata[-1].attrib["type"])
else:
s += "void"
s += " "
if (declare):
# span.attrib["class"]="funcdecl"
# a=ET.SubElement(span,"a")
# a.attrib["name"]=name+"_"+m.attrib["name"]
# a.text=name+"::"+m.attrib["name"]
s += "**" + m.attrib["name"] + "**"
else:
s += "[[#" + m.attrib["name"] + "|" + m.attrib["name"] + "]]"
2016-04-02 18:26:12 +00:00
s += "**(**"
argfound = False
for a in mdata["argidx"]:
arg = mdata[a]
if (a < 0):
continue
if (a > 0):
s += ", "
else:
s += " "
2016-04-02 18:26:12 +00:00
s += make_type(arg.attrib["type"])
if ("name" in arg.attrib):
s += " " + arg.attrib["name"]
else:
s += " arg" + str(a)
2016-04-02 18:26:12 +00:00
if ("default" in arg.attrib):
s += "=" + arg.attrib["default"]
2016-04-02 18:26:12 +00:00
argfound = True
2016-04-02 18:26:12 +00:00
if (argfound):
s += " "
s += "**)**"
2016-04-02 18:26:12 +00:00
if ("qualifiers" in m.attrib):
s += " " + m.attrib["qualifiers"]
2016-04-02 18:26:12 +00:00
f.write(s + "\n")
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
def make_doku_class(node):
name = node.attrib["name"]
2016-04-02 18:26:12 +00:00
f = open(name.lower() + ".txt", "wb")
2014-02-10 01:10:30 +00:00
f.write("====== " + name + " ======\n")
2014-02-10 01:10:30 +00:00
if ("inherits" in node.attrib):
inh = node.attrib["inherits"].strip()
f.write("**Inherits:** [[" + inh.lower() + "|" + inh + "]]\\\\\n")
if ("category" in node.attrib):
f.write("**Category:** " + node.attrib["category"].strip() + "\\\\\n")
2016-04-02 18:26:12 +00:00
briefd = node.find("brief_description")
if (briefd != None):
f.write("===== Brief Description ======\n")
f.write(dokuize_text(briefd.text.strip()) + "\n")
2016-04-02 18:26:12 +00:00
methods = node.find("methods")
2016-04-02 18:26:12 +00:00
if(methods != None and len(list(methods)) > 0):
f.write("===== Member Functions ======\n")
for m in list(methods):
make_method(f, node.attrib["name"], m, False)
2016-04-02 18:26:12 +00:00
events = node.find("signals")
if(events != None and len(list(events)) > 0):
f.write("===== Signals ======\n")
for m in list(events):
make_method(f, node.attrib["name"], m, True, True)
2016-04-02 18:26:12 +00:00
members = node.find("members")
2014-02-10 01:10:30 +00:00
if(members != None and len(list(members)) > 0):
f.write("===== Member Variables ======\n")
2014-02-10 01:10:30 +00:00
for c in list(members):
s = " * "
s += make_type(c.attrib["type"]) + " "
s += "**" + c.attrib["name"] + "**"
if (c.text.strip() != ""):
s += " - " + c.text.strip()
f.write(s + "\n")
2016-04-02 18:26:12 +00:00
constants = node.find("constants")
if(constants != None and len(list(constants)) > 0):
f.write("===== Numeric Constants ======\n")
for c in list(constants):
s = " * "
s += "**" + c.attrib["name"] + "**"
if ("value" in c.attrib):
s += " = **" + c.attrib["value"] + "**"
if (c.text.strip() != ""):
s += " - " + c.text.strip()
f.write(s + "\n")
2016-04-02 18:26:12 +00:00
descr = node.find("description")
if (descr != None and descr.text.strip() != ""):
f.write("===== Description ======\n")
f.write(dokuize_text(descr.text.strip()) + "\n")
2014-02-10 01:10:30 +00:00
methods = node.find("methods")
2016-04-02 18:26:12 +00:00
if(methods != None and len(list(methods)) > 0):
f.write("===== Member Function Description ======\n")
for m in list(methods):
2016-04-02 18:26:12 +00:00
d = m.find("description")
if (d == None or d.text.strip() == ""):
continue
f.write("== " + m.attrib["name"] + " ==\n")
make_method(f, node.attrib["name"], m, False)
f.write("\\\\\n")
f.write(dokuize_text(d.text.strip()))
f.write("\n")
2014-02-10 01:10:30 +00:00
"""
2014-02-10 01:10:30 +00:00
div=ET.Element("div")
div.attrib["class"]="class";
a=ET.SubElement(div,"a")
a.attrib["name"]=node.attrib["name"]
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
h3=ET.SubElement(a,"h3")
h3.attrib["class"]="title class_title"
h3.text=node.attrib["name"]
briefd = node.find("brief_description")
if (briefd!=None):
div2=ET.SubElement(div,"div")
div2.attrib["class"]="description class_description"
div2.text=briefd.text
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
if ("inherits" in node.attrib):
ET.SubElement(div,"br")
2016-04-02 18:26:12 +00:00
div2=ET.SubElement(div,"div")
2014-02-10 01:10:30 +00:00
div2.attrib["class"]="inheritance";
span=ET.SubElement(div2,"span")
span.text="Inherits: "
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
make_type(node.attrib["inherits"],div2)
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
if ("category" in node.attrib):
ET.SubElement(div,"br")
2016-04-02 18:26:12 +00:00
div3=ET.SubElement(div,"div")
2014-02-10 01:10:30 +00:00
div3.attrib["class"]="category";
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
span=ET.SubElement(div3,"span")
span.attrib["class"]="category"
span.text="Category: "
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
a = ET.SubElement(div3,"a")
a.attrib["class"]="category_ref"
a.text=node.attrib["category"]
catname=a.text
if (catname.rfind("/")!=-1):
2016-04-02 18:26:12 +00:00
catname=catname[catname.rfind("/"):]
2014-02-10 01:10:30 +00:00
catname="CATEGORY_"+catname
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
if (single_page):
a.attrib["href"]="#"+catname
else:
a.attrib["href"]="category.html#"+catname
2016-04-02 18:26:12 +00:00
methods = node.find("methods")
2014-02-10 01:10:30 +00:00
if(methods!=None and len(list(methods))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Methods:"
2016-04-02 18:26:12 +00:00
method_table=ET.SubElement(div,"table")
2014-02-10 01:10:30 +00:00
method_table.attrib["class"]="method_list";
for m in list(methods):
# li = ET.SubElement(div2, "li")
method_table.append( make_method_def(node.attrib["name"],m,False) )
2016-04-02 18:26:12 +00:00
events = node.find("signals")
2014-02-10 01:10:30 +00:00
if(events!=None and len(list(events))>0):
h4=ET.SubElement(div,"h4")
h4.text="Events:"
2016-04-02 18:26:12 +00:00
event_table=ET.SubElement(div,"table")
2014-02-10 01:10:30 +00:00
event_table.attrib["class"]="method_list";
for m in list(events):
# li = ET.SubElement(div2, "li")
event_table.append( make_method_def(node.attrib["name"],m,False,True) )
2016-04-02 18:26:12 +00:00
members = node.find("members")
2014-02-10 01:10:30 +00:00
if(members!=None and len(list(members))>0):
h4=ET.SubElement(div,"h4")
h4.text="Public Variables:"
2016-04-02 18:26:12 +00:00
div2=ET.SubElement(div,"div")
2014-02-10 01:10:30 +00:00
div2.attrib["class"]="member_list";
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
for c in list(members):
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="member";
2016-04-02 18:26:12 +00:00
make_type(c.attrib["type"],div3)
2014-02-10 01:10:30 +00:00
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier member_name"
span.text=" "+c.attrib["name"]+" "
span=ET.SubElement(div3,"span")
span.attrib["class"]="member_description"
span.text=c.text
2016-04-02 18:26:12 +00:00
constants = node.find("constants")
2014-02-10 01:10:30 +00:00
if(constants!=None and len(list(constants))>0):
h4=ET.SubElement(div,"h4")
h4.text="Constants:"
2016-04-02 18:26:12 +00:00
div2=ET.SubElement(div,"div")
2014-02-10 01:10:30 +00:00
div2.attrib["class"]="constant_list";
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
for c in list(constants):
li = ET.SubElement(div2, "li")
div3=ET.SubElement(li,"div")
div3.attrib["class"]="constant";
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
span=ET.SubElement(div3,"span")
span.attrib["class"]="identifier constant_name"
span.text=c.attrib["name"]+" "
if ("value" in c.attrib):
span=ET.SubElement(div3,"span")
span.attrib["class"]="symbol"
span.text="= "
span=ET.SubElement(div3,"span")
span.attrib["class"]="constant_value"
span.text=c.attrib["value"]+" "
span=ET.SubElement(div3,"span")
span.attrib["class"]="constant_description"
span.text=c.text
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
# ET.SubElement(div,"br")
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
descr=node.find("description")
if (descr!=None and descr.text.strip()!=""):
h4=ET.SubElement(div,"h4")
h4.text="Description:"
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
make_text_def(node.attrib["name"],div,descr.text)
2016-04-02 18:26:12 +00:00
# div2=ET.SubElement(div,"div")
2014-02-10 01:10:30 +00:00
# div2.attrib["class"]="description";
# div2.text=descr.text
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
if(methods!=None or events!=None):
h4=ET.SubElement(div,"h4")
h4.text="Method Documentation:"
iter_list = []
if (methods!=None):
iter_list+=list(methods)
if (events!=None):
iter_list+=list(events)
for m in iter_list:
descr=m.find("description")
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
if (descr==None or descr.text.strip()==""):
continue;
div2=ET.SubElement(div,"div")
div2.attrib["class"]="method_doc";
div2.append( make_method_def(node.attrib["name"],m,True) )
#anchor = ET.SubElement(div2, "a")
#anchor.attrib["name"] =
make_text_def(node.attrib["name"],div2,descr.text)
2016-04-02 18:26:12 +00:00
#div3=ET.SubElement(div2,"div")
2014-02-10 01:10:30 +00:00
#div3.attrib["class"]="description";
#div3.text=descr.text
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
return div
"""
for file in input_list:
tree = ET.parse(file)
doc = tree.getroot()
2014-02-10 01:10:30 +00:00
if ("version" not in doc.attrib):
print("Version missing from 'doc'")
sys.exit(255)
2014-02-10 01:10:30 +00:00
version = doc.attrib["version"]
2014-02-10 01:10:30 +00:00
for c in list(doc):
if (c.attrib["name"] in class_names):
continue
class_names.append(c.attrib["name"])
classes[c.attrib["name"]] = c
2016-04-02 18:26:12 +00:00
2014-02-10 01:10:30 +00:00
class_names.sort()
2016-04-02 18:26:12 +00:00
make_class_list(class_names, 4)
2014-02-10 01:10:30 +00:00
for cn in class_names:
c = classes[cn]
make_doku_class(c)