xref: /btstack/tool/python_generator.py (revision 760c66926a811b812c71f9da75ea15d6c9efb673) 
1#!/usr/bin/env python
2# BlueKitchen GmbH (c) 2018
3
4import glob
5import re
6import sys
7import os
8
9import btstack_parser as parser
10
11print('''
12Python binding generator for BTstack Server
13Copyright 2018, BlueKitchen GmbH
14''')
15
16# com.bluekitchen.btstack.BTstack.java templates
17command_builder_header = \
18'''#!/usr/bin/env python3
19
20import struct
21
22def opcode(ogf, ocf):
23    return ocf | (ogf << 10)
24
25def pack24(value):
26    return struct.pack("B", value & 0xff) + struct.pack("<H", value >> 8)
27
28def name248(str):
29    arg = str.encode('utf-8')
30    return arg[:248] + bytes(248-len(arg))
31
32# Command Builder
33
34class CommandBuilder(object):
35
36    def __init__(self):
37        pass
38
39    def send_command(command):
40        return FALSE
41
42'''
43
44command_builder_command = '''
45    def {name}(self, {args}):
46        cmd_args = bytes()
47{args_builder}
48        cmd = struct.pack("<HB", opcode(self.{ogf}, self.{ocf}), len(cmd_args)) + cmd_args
49        return self.send_hci_command(cmd)
50'''
51
52# com.bluekitchen.btstack.EventFactory template
53event_factory_template = \
54'''
55
56# dictionary to map hci event types to event classes
57event_class_for_type = {{
58{1}}}
59
60# dictionary to map hci le event types to event classes
61le_event_class_for_type = {{
62{2}}}
63
64# list of all event types - not actually used
65{0}
66
67def event_for_payload(payload):
68    event_type  = payload[0]
69    event_class = btstack.btstack_types.Event
70    # LE Subevent
71    if event_type == 0x3e:
72        subevent_type = payload[2]
73        event_class = le_event_class_for_type[subevent_type]
74    else:
75        event_class = event_class_for_type[event_type]
76    return event_class(payload)
77'''
78event_factory_event =  \
79'''    {0} : {1},
80'''
81event_factory_subevent = \
82'''    {0} : {1},
83'''
84
85event_header = '''
86import btstack.btstack_types
87'''
88
89event_template = \
90'''
91
92class {0}(btstack.btstack_types.Event):
93
94    def __init__(self, payload):
95        super().__init__(payload)
96    {1}
97    {2}
98'''
99
100event_getter = \
101'''
102    def get_{0}(self):
103        {1}
104'''
105
106event_getter_data = \
107'''# len = self.get_{length_name}()
108        return self.payload[{offset},{offset}+len]
109'''
110
111event_getter_data_fixed = \
112'''return self.payload[{offset},{offset}+{size}]
113'''
114
115event_to_string = \
116'''def __repr__(self):
117        repr  = '{0} < type=0x%02x' % self.get_event_type()
118{1}
119        repr += " >"
120        return repr
121'''
122
123
124# global variables/defines
125package  ='com.bluekitchen.btstack'
126gen_path = 'gen/' + package.replace('.', '/')
127
128defines = dict()
129defines_used = set()
130
131def size_for_type(type):
132    param_sizes = { '1' : 1, '2' : 2, '3' : 3, '4' : 4, 'H' : 2, 'B' : 6, 'D' : 8, 'E' : 240, 'N' : 248, 'P' : 16,
133                    'A' : 31, 'S' : -1, 'V': -1, 'J' : 1, 'L' : 2, 'Q' : 32, 'U' : 16, 'X' : 20, 'Y' : 24, 'Z' : 18, 'T':-1}
134    return param_sizes[type]
135
136def create_command_python(fout, name, ogf, ocf, format, params):
137    global command_builder_command
138
139    ind = '        '
140    param_store = {
141     '1' : 'cmd_args += struct.pack("B", %s)',
142     'J' : 'cmd_args += struct.pack("B", %s)',
143     '2' : 'cmd_args += struct.pack("<H", %s)',
144     'H' : 'cmd_args += struct.pack("<H", %s)',
145     'L' : 'cmd_args += struct.pack("<H", %s)',
146     '3' : 'cmd_args += pack24(%s)',
147     '4' : 'cmd_args += struct.pack("<H", %s)',
148     'N' : 'cmd_args += name248(%s)',
149     'B' : 'cmd_args += %s.get_bytes()',
150     'U' : 'cmd_args += %s.get_bytes()',
151     'X' : 'cmd_args += %s.get_bytes()',
152     'Y' : 'cmd_args += %s.get_bytes()',
153     'Z' : 'cmd_args += %s.get_bytes()',
154     'S' : 'cmd_args += %s',
155     # TODO: support serialization for these
156     'D' : '# D / TODO Util.storeBytes(command, offset, %s, 8)',
157     'E' : '# E / TODO Util.storeBytes(command, offset, %s, 240)',
158     'P' : '# P / TODO Util.storeBytes(command, offset, %s, 16)',
159     'Q' : '# Q / TODO Util.storeBytes(command, offset, %s, 32)',
160     'A' : '# A / TODO Util.storeBytes(command, offset, %s, 31)',
161     }
162    # method arguments
163    arg_counter = 1
164    args = []
165    for param_type, arg_name in zip(format, params):
166        arg_size = size_for_type(param_type)
167        arg = (param_type, arg_size, arg_name)
168        args.append(arg)
169        arg_counter += 1
170
171    # method argument declaration
172    args2 = []
173    for arg in args:
174        args2.append(arg[2])
175    args_string = ', '.join(args2)
176
177    # command size (opcode, len)
178    size_fixed = 3
179    size_var = ''
180    for arg in args:
181        size = arg[1]
182        if size > 0:
183            size_fixed += size
184        else:
185            size_var += ' + %s.length' % arg[2]
186    size_string = '%u%s' % (size_fixed, size_var)
187
188    store_params = ''
189
190    length_name = ''
191    for (param_type, arg_size, arg_name) in args:
192        if param_type in ['L', 'J']:
193            length_name = arg_name
194        if param_type == 'V':
195            store_params += ind + 'Util.storeBytes(command, offset, %s, %s);' % (arg_name, length_name) + '\n';
196            length_name = ''
197        else:
198            store_params += ind + (param_store[param_type] % arg_name) + '\n';
199            size = arg_size
200
201    fout.write( command_builder_command.format(name=name, args=args_string, ogf=ogf, ocf=ocf, args_builder=store_params))
202
203def mark_define_as_used(term):
204    if term.startswith('0'):
205        return
206    defines_used.add(term)
207
208def python_define_string(key):
209    global defines
210    if key in defines:
211        return '    %s = %s\n' % (key, defines[key])
212    else:
213        return '    # defines[%s] not set\n' % key
214
215def python_defines_string(keys):
216    return '\n'.join( map(python_define_string, sorted(keys)))
217
218def create_command_builder(commands):
219    global gen_path
220    parser.assert_dir(gen_path)
221
222    outfile = '%s/command_builder.py' % gen_path
223
224    with open(outfile, 'wt') as fout:
225
226        fout.write(command_builder_header)
227
228        for command in commands:
229                (command_name, ogf, ocf, format, params) = command
230                create_command_python(fout, command_name, ogf, ocf, format, params);
231                mark_define_as_used(ogf)
232                mark_define_as_used(ocf)
233
234        fout.write('\n    # defines used\n\n')
235        for key in sorted(defines_used):
236            fout.write(python_define_string(key))
237
238def create_event(fout, event_name, format, args):
239    global gen_path
240    global event_template
241
242    param_read = {
243     '1' : 'return self.payload[{offset}]',
244     'J' : 'return self.payload[{offset}]',
245     '2' : 'return struct.unpack("<H", self.payload[{offset}, {offset}+2])',
246     'H' : 'return struct.unpack("<H", self.payload[{offset}, {offset}+2])',
247     'L' : 'return struct.unpack("<H", self.payload[{offset}, {offset}+2])',
248     '3' : 'return btstack.btstack_types.unpack24(self.payload[{offset}:3])',
249     '4' : 'return struct.unpack("<I", self.payload[{offset}, {offset}+4])',
250     'B' : 'return btstack.btstack_types.BD_ADDR(self.payload[{offset}:6])',
251     'X' : 'return btstack.btstack_types.GATTService(self.payload[{offset}:20])',
252     'Y' : 'return btstack.btstack_types.GATTCharacteristic(self.payload[{offset}:24])',
253     'Z' : 'return btstack.btstack_types.GATTCharacteristicDescriptor(self.payload[{offset}:18])',
254     'T' : 'return self.payload[{offset}:].decode("utf-8")',
255     'N' : 'return self.payload[{offset}:{offset}+248].decode("utf-8")',
256     # 'D' : 'Util.storeBytes(self.payload, %u, 8);',
257     # 'Q' : 'Util.storeBytes(self.payload, %u, 32);',
258     # 'E' : 'Util.storeBytes(data, %u, 240);',
259     # 'P' : 'Util.storeBytes(data, %u, 16);',
260     # 'A' : 'Util.storeBytes(data, %u, 31);',
261     # 'S' : 'Util.storeBytes(data, %u);'
262     'R' : 'return self.payload[{offset}:]',
263     }
264
265    offset = 2
266    getters = ''
267    length_name = ''
268    for f, arg in zip(format, args):
269        # just remember name
270        if f in ['L','J']:
271            length_name = arg.lower()
272        if f == 'R':
273            # remaining data
274            access = param_read[f].format(offset=offset)
275            size = 0
276        elif f == 'V':
277            access = event_getter_data.format(length_name=length_name, offset=offset)
278            size = 0
279        elif f in ['D', 'Q']:
280            size = size_for_type(f)
281            access = event_getter_data_fixed.format(size=size, offset=offset)
282        else:
283            access = param_read[f].format(offset=offset)
284            size = size_for_type(f)
285        getters += event_getter.format(arg.lower(), access)
286        offset += size
287    to_string_args = ''
288    for arg in args:
289        to_string_args += '        repr += ", %s = "\n' % arg
290        to_string_args += '        repr += str(self.get_%s())\n' % arg.lower()
291    to_string_method = event_to_string.format(event_name, to_string_args)
292    fout.write(event_template.format(event_name, getters, to_string_method))
293
294def event_supported(event_name):
295    parts = event_name.split('_')
296    return parts[0] in ['ATT', 'BTSTACK', 'DAEMON', 'L2CAP', 'RFCOMM', 'SDP', 'GATT', 'GAP', 'HCI', 'SM', 'BNEP']
297
298def class_name_for_event(event_name):
299    return parser.camel_case(event_name.replace('SUBEVENT','EVENT'))
300
301def create_events(fout, events):
302    global gen_path
303    gen_path_events = gen_path + '/event'
304    parser.assert_dir(gen_path_events)
305
306    for event_type, event_name, format, args in events:
307        if not event_supported(event_name):
308            continue
309        class_name = class_name_for_event(event_name)
310        create_event(fout, class_name, format, args)
311
312
313def create_event_factory(events, subevents, defines):
314    global gen_path
315    global event_factory_event
316    global event_factory_template
317
318    outfile = '%s/event_factory.py' % gen_path
319
320
321    cases = ''
322    for event_type, event_name, format, args in events:
323        event_name = parser.camel_case(event_name)
324        cases += event_factory_event.format(event_type, event_name)
325    subcases = ''
326    for event_type, event_name, format, args in subevents:
327        if not event_supported(event_name):
328            continue
329        class_name = class_name_for_event(event_name)
330        subcases += event_factory_subevent.format(event_type, class_name)
331
332    with open(outfile, 'wt') as fout:
333        # header
334        fout.write(event_header)
335        # event classes
336        create_events(fout, events)
337        create_events(fout, subevents)
338        #
339        defines_text = ''
340        # python_defines_string(,defines)
341        fout.write(event_factory_template.format(defines_text, cases, subcases))
342
343# find root
344btstack_root = os.path.abspath(os.path.dirname(sys.argv[0]) + '/..')
345gen_path = btstack_root + '/platform/daemon/binding/python/btstack/'
346
347
348# read defines from hci_cmds.h and hci.h
349defines = parser.parse_defines()
350
351# parse commands
352commands = parser.parse_commands(camel_case=False)
353
354# parse bluetooth.h to get used events
355(events, le_events, event_types) = parser.parse_events()
356
357# create events, le meta events, event factory, and
358create_event_factory(events, le_events, event_types)
359create_command_builder(commands)
360
361# done
362print('Done!')
363