-
Notifications
You must be signed in to change notification settings - Fork 1
/
nasal_api_doc_py3.py
294 lines (274 loc) · 8.67 KB
/
nasal_api_doc_py3.py
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (C) 2012 Adrian Musceac
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os, sys, glob
import io
import re, string
"""Script which generates an API documentation file for Nasal libraries
located inside $FGROOT/Nasal/
Usage: nasal_api_doc.py parse [path to $FGROOT/Nasal/]
Or configure the local path below, and ommit the path in the console.
The API doc in HTML format is generated in the current working directory"""
########### Local $FGROOT/Nasal/ path ##########
NASAL_PATH="../fgfs/fgdata/Nasal/"
def get_files(nasal_dir):
if nasal_dir[-1]!='/':
nasal_dir+='/'
try:
os.stat(nasal_dir)
except:
print("The path does not exist")
sys.exit()
fgroot_dir = nasal_dir.rstrip('/').replace('Nasal','')
f_version = open(fgroot_dir+'version','r')
version = f_version.read(256).rstrip('\n')
top_level = []
modules = []
top_namespaces = []
files_list = os.listdir(nasal_dir)
for f in files_list:
if f.find(".nas")!=-1:
top_level.append(f)
continue
if os.path.isdir(nasal_dir + f):
modules.append(f)
top_level.sort()
modules.sort()
if len(top_level) ==0:
print("This does not look like the correct $FGROOT/Nasal path")
sys.exit()
if len(modules)==0:
print("Warning: could not find any submodules")
for f in top_level:
namespace=f.replace(".nas","")
functions=parse_file(nasal_dir + f)
top_namespaces.append([namespace,functions])
for m in modules:
files=glob.glob(nasal_dir+m+"/*.nas")
for f in files:
functions=parse_file(f)
top_namespaces.append([m,functions])
output_text(top_namespaces,modules,version)
def output_text(top_namespaces,modules,version):
fw=open('./nasal_api_doc.html','wb')
buf='<html><head>\
<title>Nasal API</title>\
<style>\n\
a.main_module_link {margin-left:30px;display:block;float:left;}\
div.container {background-color:#eee;clear:left;margin-top:20px;}\
h2.namespace_title {padding-left:20px;color:#fff;background-color:#8888AC}\
h4.class_function {padding-left:20px;background-color:#eee;color:#000033}\
h4.class_definition {padding-left:20px;background-color:#eee;color:#000033}\
h4.function {padding-left:20px;background-color:#eee;color:#000033}\
hr {margin-left:30px;margin-right:30px;}\
div.comments {padding-left:40px;display:inline;font-size:12px;}\
</style>\n\
</head><body style="width:1024px;">'
buf+='<h1 style="padding-left:20px;display:block;color:#fff;background-color:#555588;">\
Nasal $FGROOT Library<br/><span style="font-size:12px;">Flightgear version: '+version+'\
<br/>This file is generated automatically by scripts/python/nasal_api_doc.py\
</span></h1>\
<br/><a href="http://plausible.org/nasal">Nasal documentation</a> \
<a href="http://wiki.flightgear.org/Nasal_scripting_language">Flightgear Nasal documentation</a>\n<div style="float:right;"> '
buf+='<h2 style="font-size:14px;height:450px;width:250px;overflow:scroll;display:block;position:fixed;top:20px;right:20px;background-color:#8888AC;border:1px solid black;">\n'
done=[]
for namespace in top_namespaces:
color='0000cc'
if namespace[0] in modules:
color='cc0000'
if namespace[0] not in done:
buf+='<a class="main_module_link" style="color:'+color+'" href="#'+namespace[0]+'">'+namespace[0]+'</a> <br/>\n'
done.append(namespace[0])
buf+='</h2></div>\n'
done2=[]
for namespace in top_namespaces:
if namespace[0] not in done2:
buf+='<div class="container" style="">\n'
buf += '<h2 class="namespace_title"><a name="'+namespace[0]+'">'+namespace[0]+'</a></h2>\n'
done2.append(namespace[0])
for functions in namespace[1]:
class_func=functions[0].split('.')
if len(class_func)>1:
f_name=''
if class_func[1].find('_')==0:
f_name='<font color="#0000cc">'+class_func[1]+'</font>'
else:
f_name=class_func[1]
if class_func[1]!='':
buf+= '<div><h4 class="class_function"><b>'\
+namespace[0]+'</b>'+ "." + '<b><i>'+class_func[0]+'</i></b>'+'<b>.'+f_name+'</b>'+' ( <font color="#cc0000">'+ functions[1]+ '</font> )' +'</h4>\n'
else:
buf+= '<div><h4 class="class_definition"><b>'\
+namespace[0]+'</b>'+ "." + '<b><i><u><font color="#000000">'+class_func[0]+'</font></u></i></b>' +'</h4>\n'
else:
if functions[0].find('_')==0:
f_name='<font color="#0000cc">'+functions[0]+'</font>'
else:
f_name=functions[0]
buf+= '<div><h4 class="function"><b>'\
+namespace[0]+'</b>'+ "." + '<b>'+f_name+'</b>'+ ' ( <font color="#cc0000">'+ functions[1]+ '</font> )' +'</h4>\n'
for comment in functions[2]:
if comment.find('=====')!=-1:
buf+='<hr/>'
else:
tempComment = comment.replace('#','').replace('<','<').replace('>','>')
if tempComment.strip()!="":
buf+= '<div class="comments">'+tempComment+'</div><br/>\n'
buf+='</div>\n'
if namespace[0] not in done2:
buf+='</div>\n'
buf+='</body></html>'
fw.write(buf.encode('utf8'))
fw.close()
def parse_file(filename):
fr=open(filename,'r')
content=fr.readlines()
i=0
retval=[]
classname=""
for line in content:
match=re.search(r'^var\s+([A-Za-z0-9_-]+)\s*=\s*func\s*\(?([A-Za-z0-9_\s,=.\n-]*)\)?',line)
if match!=None:
func_name=match.group(1)
comments=[]
param=match.group(2)
if(line.find(')')==-1 and line.find('(')!=-1):
k=i+1
while(content[k].find(')')==-1):
param+=content[k].rstrip('\n')
k+=1
param+=content[k].split(')')[0]
j=i-1
count=0
while ( j>i-35 and j>-1):
if count>3:
break
if len(content[j])<2:
j-=1
count+=1
continue
if re.search(r'^\s*#',content[j])!=None:
comments.append(content[j].rstrip('\n'))
j-=1
else:
break
if(len(comments)>1):
comments.reverse()
retval.append((func_name, param,comments))
i+=1
continue
match3=re.search(r'^var\s*([A-Za-z0-9_-]+)\s*=\s*{\s*(\n|})',line)
if match3!=None:
classname=match3.group(1)
comments=[]
j=i-1
count=0
while ( j>i-35 and j>-1):
if count>3:
break
if len(content[j])<2:
j-=1
count+=1
continue
if re.search(r'^\s*#',content[j])!=None:
comments.append(content[j].rstrip('\n'))
j-=1
else:
break
if(len(comments)>1):
comments.reverse()
retval.append((classname+'.', '',comments))
i+=1
continue
match2=re.search(r'^\s*([A-Za-z0-9_-]+)\s*:\s*func\s*\(?([A-Za-z0-9_\s,=.\n-]*)\)?',line)
if match2!=None:
func_name=match2.group(1)
comments=[]
param=match2.group(2)
if(line.find(')')==-1 and line.find('(')!=-1):
k=i+1
while(content[k].find(')')==-1):
param+=content[k].rstrip('\n')
k+=1
param+=content[k].split(')')[0]
j=i-1
count=0
while ( j>i-35 and j>-1):
if count>3:
break
if len(content[j])<2:
j-=1
count+=1
continue
if re.search(r'^\s*#',content[j])!=None:
comments.append(content[j].rstrip('\n'))
j-=1
else:
break
if(len(comments)>1):
comments.reverse()
if classname =='':
continue
retval.append((classname+'.'+func_name, param,comments))
i+=1
continue
match4=re.search(r'^([A-Za-z0-9_-]+)\.([A-Za-z0-9_-]+)\s*=\s*func\s*\(?([A-Za-z0-9_\s,=\n.-]*)\)?',line)
if match4!=None:
classname=match4.group(1)
func_name=match4.group(2)
comments=[]
param=match4.group(3)
if(line.find(')')==-1 and line.find('(')!=-1):
k=i+1
while(content[k].find(')')==-1):
param+=content[k].rstrip('\n')
k+=1
param+=content[k].split(')')[0]
j=i-1
count=0
while ( j>i-35 and j>-1):
if count>3:
break
if len(content[j])<2:
j-=1
count+=1
continue
if re.search(r'^\s*#',content[j])!=None:
comments.append(content[j].rstrip('\n'))
j-=1
else:
break
if(len(comments)>1):
comments.reverse()
retval.append((classname+'.'+func_name, param,comments))
i+=1
continue
i+=1
return retval
if __name__ == "__main__":
if len(sys.argv) <2:
print('Usage: nasal_api_doc.py parse [path to $FGROOT/Nasal/]')
sys.exit()
else:
if sys.argv[1]=='parse':
if len(sys.argv) <3:
nasal_path=NASAL_PATH
else:
nasal_path=sys.argv[2]
get_files(nasal_path)
else:
print('Usage: nasal_api_doc.py parse [path to $FGROOT/Nasal/]')
sys.exit()