vppapigen: include comments in json
[vpp.git] / src / tools / vppapigen / vppapigen_json.py
1 # JSON generation
2 import json
3
4 process_imports = True
5
6
7 def walk_imports(s):
8     r = []
9     for e in s:
10         r.append(str(e))
11     return r
12
13
14 def walk_counters(s, pathset):
15     r = []
16     for e in s:
17         r2 = {"name": e.name, "elements": e.block}
18         r.append(r2)
19
20     r3 = []
21     for p in pathset:
22         r3.append(p.paths)
23
24     return r, r3
25
26
27 def walk_enums(s):
28     r = []
29     for e in s:
30         d = []
31         d.append(e.name)
32         for b in e.block:
33             d.append(b)
34         d.append({"enumtype": e.enumtype})
35         r.append(d)
36     return r
37
38
39 def walk_services(s):
40     r = {}
41     for e in s:
42         d = {"reply": e.reply}
43         if e.stream:
44             d["stream"] = True
45         if e.stream_message:
46             d["stream_msg"] = e.stream_message
47         if e.events:
48             d["events"] = e.events
49         r[e.caller] = d
50     return r
51
52
53 def walk_defs(s, is_message=False):
54     r = []
55     for t in s:
56         d = []
57         d.append(t.name)
58         for b in t.block:
59             if b.type == "Option":
60                 continue
61             if b.type == "Field":
62                 if b.limit:
63                     d.append([b.fieldtype, b.fieldname, b.limit])
64                 else:
65                     d.append([b.fieldtype, b.fieldname])
66             elif b.type == "Array":
67                 if b.lengthfield:
68                     d.append([b.fieldtype, b.fieldname, b.length, b.lengthfield])
69                 else:
70                     d.append([b.fieldtype, b.fieldname, b.length])
71             elif b.type == "Union":
72                 pass
73             else:
74                 raise ValueError("Error in processing array type %s" % b)
75
76         if is_message and t.crc:
77             c = {}
78             c["crc"] = "{0:#0{1}x}".format(t.crc, 10)
79             c["options"] = t.options
80             c["comment"] = t.comment
81             d.append(c)
82
83         r.append(d)
84     return r
85
86
87 #
88 # Plugin entry point
89 #
90 def run(output_dir, filename, s):
91     j = {}
92
93     j["types"] = walk_defs([o for o in s["types"] if o.__class__.__name__ == "Typedef"])
94     j["messages"] = walk_defs(s["Define"], True)
95     j["unions"] = walk_defs([o for o in s["types"] if o.__class__.__name__ == "Union"])
96     j["enums"] = walk_enums([o for o in s["types"] if o.__class__.__name__ == "Enum"])
97     j["enumflags"] = walk_enums(
98         [o for o in s["types"] if o.__class__.__name__ == "EnumFlag"]
99     )
100     j["services"] = walk_services(s["Service"])
101     j["options"] = s["Option"]
102     j["aliases"] = {
103         o.name: o.alias for o in s["types"] if o.__class__.__name__ == "Using"
104     }
105     j["vl_api_version"] = hex(s["file_crc"])
106     j["imports"] = walk_imports(i for i in s["Import"])
107     j["counters"], j["paths"] = walk_counters(s["Counters"], s["Paths"])
108     return json.dumps(j, indent=4, separators=(",", ": "))