-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkapi.py
327 lines (267 loc) · 10.2 KB
/
mkapi.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# licensed under MIT
# see LICENSE
from __future__ import print_function
import argparse
import re
import os
import sys
from collections import namedtuple
from xml.sax.saxutils import quoteattr as s_xml_quoteattr
from xml.sax.saxutils import escape as s_xml_escape
from pycparser import c_parser, c_ast, parse_file
__doc__ = """Generate zproto API XML model from CLASS compatible function declarations"""
MacroDecl = namedtuple("MacroDecl", "name, value, comment")
TypeDecl = namedtuple("TypeDecl", "type, ptr")
ArgDecl = namedtuple("ArgDecl", "name, type, ptr")
def s_parse_comments_and_macros(fp):
interface_re = re.compile(r"^//\W*@interface\W*$")
end_re = re.compile(r"^//\W*@end\W*$")
macro_re = re.compile(r"^#define.*$")
comments = dict()
macros = list()
is_interface = False
last_comment = ""
# go to @interface
for i, line in enumerate(fp):
if not is_interface:
if not interface_re.match(line):
continue
is_interface = True
continue
if end_re.match(line):
break
if macro_re.match(line):
try:
_, name, value, comment = line.split(' ', 3)
comment = comment.strip()[3:]
except ValueError:
_, name, value = line.split(' ', 2)
value = value.strip()
comment = ""
macros.append(MacroDecl(name, value, comment))
continue
if line.startswith("//"):
last_comment += line[2:].lstrip()
continue
if last_comment:
comments[i] = last_comment
last_comment = ""
return comments, macros
def parse_comments_and_macros(filename):
"""Return comments, macros objects from file
comments are tuple (line, comment)
macros are (name, value, comment)
Function use content between @interface @end lines only
"""
with open(filename) as fp:
return s_parse_comments_and_macros(fp)
class FuncDeclVisitor(c_ast.NodeVisitor):
def __init__(self, *args, **kwargs):
super(FuncDeclVisitor, self).__init__(*args, **kwargs)
self._ret = list()
@staticmethod
def s_decl_type(node):
ptr = ''
while isinstance(node, c_ast.PtrDecl):
ptr = ptr + '*'
node = node.type
for attr in ("names", "name"):
if not hasattr(node.type, attr):
continue
return TypeDecl(' '.join(getattr(node.type, attr)), ptr)
raise AttributeError("%s do not have .type.names or .type.name" % (node.__class__.__name__))
@staticmethod
def s_func_args(node):
if node.args is None:
return (ArgDecl('', "void", ''), )
ret = list()
for idx, n in node.args.children():
if isinstance(n, (c_ast.Decl, c_ast.Typename)):
typ, ptr = FuncDeclVisitor.s_decl_type(n.type)
ret.append((ArgDecl(n.name, typ, ptr)))
elif isinstance(n, c_ast.EllipsisParam):
ret.append(ArgDecl("", "...", ""))
else:
raise NotImplementedError("%s is not supported in s_func_args" % (n.__class__.__name__))
return tuple(ret)
@staticmethod
def s_decl_dict(node):
decl_dict = {
"return_type" : FuncDeclVisitor.s_decl_type(node.type.type),
"name" : node.name,
"args" : FuncDeclVisitor.s_func_args(node.type),
"coord" : node.coord,
}
return decl_dict
@staticmethod
def s_enum_items(enumerators):
return [MacroDecl(n.name, n.value.value, "") for n in enumerators if n.value is not None]
@staticmethod
def s_enum_dict(node):
decl_dict = {
"type" : "enum",
"name" : node.name,
"items" : FuncDeclVisitor.s_enum_items(node.type.type.values.enumerators),
"coord" : node.coord
}
return decl_dict
def visit_Decl(self, node):
if not isinstance (node.type, c_ast.FuncDecl):
return
decl_dict = FuncDeclVisitor.s_decl_dict(node)
typ = "singleton"
if decl_dict["args"] and \
decl_dict["args"][0].name in ("self", "self_p") and \
decl_dict["args"][0].type.endswith("_t") and \
decl_dict["args"][0].ptr == "*":
typ = "method"
decl_dict["type"] = typ
self._ret.append(decl_dict)
def visit_Typedef(self, node):
if isinstance(node.type, c_ast.FuncDecl):
decl_dict = FuncDeclVisitor.s_decl_dict(node)
decl_dict["type"] = "callback_type"
self._ret.append(decl_dict)
return
elif isinstance(node.type.type, c_ast.Enum):
decl_dict = FuncDeclVisitor.s_enum_dict(node)
self._ret.append(decl_dict)
return
def s_cpp_args(args):
cpp_args = list()
try:
for d in args.DEFINE:
cpp_args.append("-D" + d)
except TypeError:
pass
try:
for d in args.INCLUDE:
cpp_args.append("-I" + d)
except TypeError:
pass
return cpp_args
def get_func_decls(filename, args):
cpp_args = s_cpp_args(args)
ast = parse_file(filename,
use_cpp=True,
cpp_path=os.path.join(os.path.dirname(__file__), "fake_cpp"),
cpp_args=cpp_args)
v = FuncDeclVisitor()
for idx, node in ast.children():
v.visit(node)
return v._ret
def s_decl_to_zproto_type(arg):
dct = {
("void", "*") : "anything",
("int", "") : "integer",
("float", "") : "real",
("bool", "") : "boolean",
("_Bool", "") : "boolean",
("char", "*") : "string",
}
if arg.type.endswith("_t") and arg.ptr in ("*", "**"):
return arg.type[:-2]
return dct.get((arg.type, arg.ptr), arg.type)
def s_show_zproto_model_arguments(fp, decl_dict):
was_format = False
for arg in decl_dict["args"]:
if arg.name in ("self", "self_p") and arg.type != "void":
continue
if was_format and arg.type == "...":
continue
if arg.name == "format" and arg.type == "char" and arg.ptr == "*":
was_format = True
print(""" <argument name = "%(name)s" type = "%(type)s"%(byref)s/>""" %
{ "name" : arg.name,
"type" : s_decl_to_zproto_type(arg),
"byref" : """ by_reference="1" """ if arg.ptr == "**" else "",
}, file=fp)
def s_show_zproto_mc(fp, klass_l, dct, comments):
"""Show method or callback_type - they're mostly the same except tag name"""
typ = dct["type"]
singleton=''
if typ == "singleton":
typ = "method"
singleton=""" singleton = "1" """
print(""" <%s name = "%s"%s>""" % (typ, dct["name"][klass_l:], singleton), file=fp)
for i in range(3):
if dct["coord"].line -i in comments:
print(s_xml_escape(comments[dct["coord"].line-i]), file=fp)
s_show_zproto_model_arguments(fp, dct)
if dct["return_type"].type != "void":
print(""" <return type = "%s" />""" % (s_decl_to_zproto_type(dct["return_type"])), file=fp)
print(""" </%s>\n""" % (typ, ), file=fp)
def s_show_zproto_enum(fp, klass_l, decl_dict):
print(""" <enum name="%s">""" % (decl_dict["name"][klass_l:-2].lower()), file=fp)
for name, value, comment in decl_dict["items"]:
name = name[klass_l:].lower()
print (""" <constant name="%s" value="%s" />""" % (name, value), file=fp)
print(""" </enum>""", file=fp)
def show_zproto_model(fp, klass, decls, comments, macros):
print("""
<!--
This model defines a public API for binding.
-->
<class name = "%s" >
<include filename = "../license.xml" />
""" % (klass, ), file=fp)
klass_l = len(klass) + 1
include = os.path.join("include", klass + ".h")
for macro_decl in macros:
print(""" <constant name = "%s" value = %s >%s</constant>\n""" % (
macro_decl.name[klass_l:].lower(),
s_xml_quoteattr(macro_decl.value),
macro_decl.comment),
file=fp)
for decl_dict in (d for d in decls if d["coord"].file == include):
if decl_dict["type"] == "enum":
s_show_zproto_enum(fp, klass_l, decl_dict)
continue
if decl_dict["name"] == klass + "_new":
print("""
<!-- Constructor is optional; default one has no arguments -->
<constructor>
Create a new %s""" % (klass, ), file=fp)
s_show_zproto_model_arguments(fp, decl_dict)
print(""" </constructor>""", file=fp)
continue
if decl_dict["name"] == klass + "_destroy":
print("""
<!-- Destructor is optional; default one follows standard style -->
<destructor />\n""", file=fp)
continue
s_show_zproto_mc(fp, klass_l, decl_dict, comments)
print("</class>", file=fp)
def get_classes_from_decls(decls):
seen = set()
for decl_dict in decls:
name = decl_dict["name"]
klass = name[:name.rfind('_')]
include = os.path.join("include", klass + ".h")
if not os.path.exists(include):
continue
if klass in seen:
continue
seen.add(klass)
yield klass
def main(argv=sys.argv[1:]):
p = argparse.ArgumentParser(description=__doc__)
p.add_argument("header", help="main header file of the project")
p.add_argument("-D", "--define", help="", dest="DEFINE", action='append')
p.add_argument("-I", "--include", help="", dest="INCLUDE", action='append')
args = p.parse_args(argv)
args.output = "api"
try:
os.makedirs(args.output)
except OSError as e:
if e.errno != 17: #file exists
raise e
decls = get_func_decls(args.header, args)
for klass in get_classes_from_decls(decls):
include = os.path.join("include", klass + ".h")
comments, macros = parse_comments_and_macros(include)
model = os.path.join(args.output, klass + ".xml")
with open(model, 'wt') as fp:
show_zproto_model(fp, klass, decls, comments, macros)
if __name__ == "__main__":
main()