api.py 28.5 KB
Newer Older
1
import string, sys, re, runpy
Paul Fultz II's avatar
Paul Fultz II committed
2
from functools import wraps
3
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
Paul Fultz II's avatar
Paul Fultz II committed
4

5
6
7
8
type_map: Dict[str, Callable[['Parameter'], None]] = {}
cpp_type_map: Dict[str, str] = {}
functions: List['Function'] = []
cpp_classes: List['CPPClass'] = []
Paul Fultz II's avatar
Paul Fultz II committed
9
10
11
12
error_type = ''
success_type = ''
try_wrap = ''

13
14
15
c_header_preamble: List[str] = []
c_api_body_preamble: List[str] = []
cpp_header_preamble: List[str] = []
Paul Fultz II's avatar
Paul Fultz II committed
16
17


18
def bad_param_error(msg: str):
Paul Fultz II's avatar
Paul Fultz II committed
19
20
21
22
23
24
25
26
    return 'throw std::runtime_error("{}")'.format(msg)


class Template(string.Template):
    idpattern = '[_a-zA-Z0-9@]+'


class Type:
27
    def __init__(self, name: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
28
29
        self.name = name.strip()

30
    def is_pointer(self) -> bool:
Paul Fultz II's avatar
Paul Fultz II committed
31
32
        return self.name.endswith('*')

33
    def is_reference(self) -> bool:
Paul Fultz II's avatar
Paul Fultz II committed
34
35
        return self.name.endswith('&')

36
    def is_const(self) -> bool:
Paul Fultz II's avatar
Paul Fultz II committed
37
38
        return self.name.startswith('const ')

39
40
41
    def is_variadic(self):
        return self.name.startswith('...')

42
    def add_pointer(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
43
44
45
46
47
        return Type(self.name + '*')

    def add_reference(self):
        return Type(self.name + '&')

48
    def add_const(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
49
50
        return Type('const ' + self.name)

51
    def inner_type(self) -> Optional['Type']:
Paul Fultz II's avatar
Paul Fultz II committed
52
53
54
55
56
57
58
        i = self.name.find('<')
        j = self.name.rfind('>')
        if i > 0 and j > 0:
            return Type(self.name[i + 1:j])
        else:
            return None

59
    def remove_generic(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
60
61
62
63
64
65
66
        i = self.name.find('<')
        j = self.name.rfind('>')
        if i > 0 and j > 0:
            return Type(self.name[0:i] + self.name[j + 1:])
        else:
            return self

67
    def remove_pointer(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
68
69
70
71
        if self.is_pointer():
            return Type(self.name[0:-1])
        return self

72
    def remove_reference(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
73
74
75
76
        if self.is_reference():
            return Type(self.name[0:-1])
        return self

77
    def remove_const(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
78
79
80
81
        if self.is_const():
            return Type(self.name[6:])
        return self

82
    def basic(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
83
84
        return self.remove_pointer().remove_const().remove_reference()

85
    def decay(self) -> 'Type':
Paul Fultz II's avatar
Paul Fultz II committed
86
87
88
89
90
91
        t = self.remove_reference()
        if t.is_pointer():
            return t
        else:
            return t.remove_const()

92
    def const_compatible(self, t: 'Type'):
Paul Fultz II's avatar
Paul Fultz II committed
93
94
95
96
        if t.is_const():
            return self.add_const()
        return self

97
    def str(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
98
99
100
101
102
103
104
105
106
107
        return self.name


header_function = Template('''
${error_type} ${name}(${params});
''')

c_api_impl = Template('''
extern "C" ${error_type} ${name}(${params})
{
108
    ${va_start}auto api_error_result = ${try_wrap}([&] {
Paul Fultz II's avatar
Paul Fultz II committed
109
110
        ${body};
    });
111
    ${va_end}return api_error_result;
Paul Fultz II's avatar
Paul Fultz II committed
112
113
114
115
116
}
''')


class CFunction:
117
    def __init__(self, name: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
118
        self.name = name
119
120
121
122
        self.params: List[str] = []
        self.body: List[str] = []
        self.va_start: List[str] = []
        self.va_end: List[str] = []
Paul Fultz II's avatar
Paul Fultz II committed
123

124
    def add_param(self, type: str, pname: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
125
126
        self.params.append('{} {}'.format(type, pname))

127
    def add_statement(self, stmt: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
128
129
        self.body.append(stmt)

130
    def add_vlist(self, name: str) -> None:
131
132
133
134
135
136
137
138
        last_param = self.params[-1].split()[-1]
        self.va_start = [
            'va_list {};'.format(name),
            'va_start({}, {});'.format(name, last_param)
        ]
        self.va_end = ['va_end({});'.format(name)]
        self.add_param('...', '')

139
    def substitute(self, form: Template) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
140
141
142
143
        return form.substitute(error_type=error_type,
                               try_wrap=try_wrap,
                               name=self.name,
                               params=', '.join(self.params),
144
145
146
                               body=";\n        ".join(self.body),
                               va_start="\n    ".join(self.va_start),
                               va_end="\n    ".join(self.va_end))
Paul Fultz II's avatar
Paul Fultz II committed
147

148
    def generate_header(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
149
150
        return self.substitute(header_function)

151
    def generate_body(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
152
153
154
155
        return self.substitute(c_api_impl)


class BadParam:
156
    def __init__(self, cond: str, msg: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
157
158
159
160
161
        self.cond = cond
        self.msg = msg


class Parameter:
162
163
164
165
166
    def __init__(self,
                 name: str,
                 type: str,
                 optional: bool = False,
                 returns: bool = False) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
167
168
169
        self.name = name
        self.type = Type(type)
        self.optional = optional
170
        self.cparams: List[Tuple[str, str]] = []
Paul Fultz II's avatar
Paul Fultz II committed
171
172
173
174
175
176
177
        self.size_cparam = -1
        self.size_name = ''
        self.read = '${name}'
        self.write = ['*${name} = ${result}']
        self.cpp_read = '${name}'
        self.cpp_write = '${name}'
        self.returns = returns
178
        self.bad_param_check: Optional[BadParam] = None
Paul Fultz II's avatar
Paul Fultz II committed
179

180
    def get_name(self, prefix: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
181
182
183
184
185
        if prefix:
            return prefix + self.name
        else:
            return self.name

186
    def get_cpp_type(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
187
188
189
190
191
192
193
194
195
        if self.type.str() in cpp_type_map:
            return cpp_type_map[self.type.basic().str()]
        elif self.type.basic().str() in cpp_type_map:
            return cpp_type_map[self.type.basic().str()]
        elif self.returns:
            return self.type.decay().str()
        else:
            return self.type.str()

196
197
198
199
    def substitute(self,
                   s: str,
                   prefix: Optional[str] = None,
                   result: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
200
201
202
203
204
205
206
207
208
209
        ctype = None
        if len(self.cparams) > 0:
            ctype = Type(self.cparams[0][0]).basic().str()
        return Template(s).safe_substitute(name=self.get_name(prefix),
                                           type=self.type.str(),
                                           ctype=ctype or '',
                                           cpptype=self.get_cpp_type(),
                                           size=self.size_name,
                                           result=result or '')

210
211
    def add_param(self, t: Union[str, Type],
                  name: Optional[str] = None) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
212
213
214
215
        if not isinstance(t, str):
            t = t.str()
        self.cparams.append((t, name or self.name))

216
    def add_size_param(self, name: Optional[str] = None) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
217
218
219
220
221
222
223
        self.size_cparam = len(self.cparams)
        self.size_name = name or self.name + '_size'
        if self.returns:
            self.add_param('size_t *', self.size_name)
        else:
            self.add_param('size_t', self.size_name)

224
    def bad_param(self, cond: str, msg: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
225
226
227
228
229
230
231
232
233
234
        self.bad_param_check = BadParam(cond, msg)

    def remove_size_param(self, name):
        p = None
        if self.size_cparam >= 0:
            p = self.cparams[self.size_cparam]
            del self.cparams[self.size_cparam]
            self.size_name = name
        return p

235
    def update(self) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
        t = self.type.basic().str()
        g = self.type.remove_generic().basic().str()
        if t in type_map:
            type_map[t](self)
        elif g in type_map:
            type_map[g](self)
        else:
            if self.returns:
                self.add_param(self.type.remove_reference().add_pointer())
            else:
                self.add_param(self.type.remove_reference())
        if isinstance(self.write, str):
            raise ValueError("Error for {}: write cannot be a string".format(
                self.type.str()))

251
    def cpp_param(self, prefix: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
252
253
        return self.substitute('${cpptype} ${name}', prefix=prefix)

254
    def cpp_arg(self, prefix: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
255
256
        return self.substitute(self.cpp_read, prefix=prefix)

257
    def cpp_output_args(self, prefix: Optional[str] = None) -> List[str]:
Paul Fultz II's avatar
Paul Fultz II committed
258
259
260
261
        return [
            '&{prefix}{n}'.format(prefix=prefix, n=n) for t, n in self.cparams
        ]

262
    def output_declarations(self, prefix: Optional[str] = None) -> List[str]:
Paul Fultz II's avatar
Paul Fultz II committed
263
264
265
266
267
268
269
270
271
272
273
        return [
            '{type} {prefix}{n};'.format(type=Type(t).remove_pointer().str(),
                                         prefix=prefix,
                                         n=n) for t, n in self.cparams
        ]

    def output_args(self, prefix=None):
        return [
            '&{prefix}{n};'.format(prefix=prefix, n=n) for t, n in self.cparams
        ]

274
    def cpp_output(self, prefix: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
275
276
        return self.substitute(self.cpp_write, prefix=prefix)

277
    def input(self, prefix: Optional[str] = None) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
278
279
        return '(' + self.substitute(self.read, prefix=prefix) + ')'

280
    def outputs(self, result: Optional[str] = None) -> List[str]:
Paul Fultz II's avatar
Paul Fultz II committed
281
282
        return [self.substitute(w, result=result) for w in self.write]

283
    def add_to_cfunction(self, cfunction: CFunction) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
284
        for t, name in self.cparams:
285
286
287
288
            if t.startswith('...'):
                cfunction.add_vlist(name)
            else:
                cfunction.add_param(self.substitute(t), self.substitute(name))
Paul Fultz II's avatar
Paul Fultz II committed
289
290
291
292
293
294
295
296
        if self.bad_param_check:
            msg = 'Bad parameter {name}: {msg}'.format(
                name=self.name, msg=self.bad_param_check.msg)
            cfunction.add_statement('if ({cond}) {body}'.format(
                cond=self.substitute(self.bad_param_check.cond),
                body=bad_param_error(msg)))


297
def template_var(s: str) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
298
299
300
    return '${' + s + '}'


301
def to_template_vars(params: List[Union[Any, Parameter]]) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
302
303
304
305
306
    return ', '.join([template_var(p.name) for p in params])


class Function:
    def __init__(self,
307
308
309
310
311
312
313
314
                 name: str,
                 params: Optional[List[Parameter]] = None,
                 shared_size: bool = False,
                 returns: Optional[str] = None,
                 invoke: Optional[str] = None,
                 fname: Optional[str] = None,
                 return_name: Optional[str] = None,
                 **kwargs) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
315
316
317
        self.name = name
        self.params = params or []
        self.shared_size = False
318
        self.cfunction: Optional[CFunction] = None
Paul Fultz II's avatar
Paul Fultz II committed
319
320
321
322
323
324
        self.fname = fname
        self.invoke = invoke or '${__fname__}($@)'
        self.return_name = return_name or 'out'
        self.returns = Parameter(self.return_name, returns,
                                 returns=True) if returns else None

325
    def share_params(self) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
326
327
328
329
330
331
332
333
334
        if self.shared_size == True:
            size_param_name = 'size'
            size_type = Type('size_t')
            for param in self.params:
                p = param.remove_size_param(size_param_name)
                if p:
                    size_type = Type(p[0])
            self.params.append(Parameter(size_param_name, size_type.str()))

335
    def update(self) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
336
337
338
339
340
341
342
        self.share_params()
        for param in self.params:
            param.update()
        if self.returns:
            self.returns.update()
        self.create_cfunction()

343
    def inputs(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
344
345
        return ', '.join([p.input() for p in self.params])

346
347
348
    # TODO: Shoule we remove Optional?
    def input_map(self) -> Dict[str, Optional[str]]:
        m: Dict[str, Optional[str]] = {}
Paul Fultz II's avatar
Paul Fultz II committed
349
350
351
352
353
354
355
        for p in self.params:
            m[p.name] = p.input()
        m['return'] = self.return_name
        m['@'] = self.inputs()
        m['__fname__'] = self.fname
        return m

356
    def get_invoke(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
357
358
        return Template(self.invoke).safe_substitute(self.input_map())

359
360
361
    def write_to_tmp_var(self) -> bool:
        if not self.returns:
            return False
Paul Fultz II's avatar
Paul Fultz II committed
362
363
364
        return len(self.returns.write) > 1 or self.returns.write[0].count(
            '${result}') > 1

365
366
367
368
369
370
371
    def get_cfunction(self) -> CFunction:
        if self.cfunction:
            return self.cfunction
        raise Exception(
            "self.cfunction is None: self.update() needs to be called.")

    def create_cfunction(self) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
372
373
374
375
376
377
378
        self.cfunction = CFunction(self.name)
        # Add the return as a parameter
        if self.returns:
            self.returns.add_to_cfunction(self.cfunction)
        # Add the input parameters
        for param in self.params:
            param.add_to_cfunction(self.cfunction)
379
        f: Optional[str] = self.get_invoke()
Paul Fultz II's avatar
Paul Fultz II committed
380
381
382
383
        # Write the assignments
        assigns = []
        if self.returns:
            result = f
384
            if self.write_to_tmp_var() and f:
Paul Fultz II's avatar
Paul Fultz II committed
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
                f = 'auto&& api_result = ' + f
                result = 'api_result'
            else:
                f = None
            assigns = self.returns.outputs(result)
        if f:
            self.cfunction.add_statement(f)
        for assign in assigns:
            self.cfunction.add_statement(assign)


cpp_class_template = Template('''

struct ${name} : handle_base<${ctype}, decltype(&${destroy}), ${destroy}>
{
    ${name}(${ctype} p, bool own = true)
    : m_handle(nullptr)
    {
        this->set_handle(p, own);
    }
    ${constructors}

    ${methods}
};
''')

cpp_class_method_template = Template('''
    ${return_type} ${name}(${params}) const
    {
        ${outputs}
        this->call_handle(${args});
        return ${result};
    }
''')

cpp_class_void_method_template = Template('''
    void ${name}(${params}) const
    {
        this->call_handle(${args});
    }
''')

cpp_class_constructor_template = Template('''
    ${name}(${params})
    : m_handle(nullptr)
    {
        m_handle = this->make_handle(${args});
    }
''')


class CPPMember:
437
438
439
440
441
    def __init__(self,
                 name: str,
                 function: Function,
                 prefix: str,
                 method: bool = True) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
442
443
444
445
446
        self.name = name
        self.function = function
        self.prefix = prefix
        self.method = method

447
    def get_function_params(self) -> List[Union[Any, Parameter]]:
Paul Fultz II's avatar
Paul Fultz II committed
448
449
450
451
452
        if self.method:
            return self.function.params[1:]
        else:
            return self.function.params

453
    def get_args(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
454
455
456
        output_args = []
        if self.function.returns:
            output_args = self.function.returns.cpp_output_args(self.prefix)
457
458
        if not self.function.cfunction:
            raise Exception('self.function.update() must be called')
Paul Fultz II's avatar
Paul Fultz II committed
459
460
461
462
        return ', '.join(
            ['&{}'.format(self.function.cfunction.name)] + output_args +
            [p.cpp_arg(self.prefix) for p in self.get_function_params()])

463
    def get_params(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
464
465
466
        return ', '.join(
            [p.cpp_param(self.prefix) for p in self.get_function_params()])

467
    def get_return_declarations(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
468
469
470
471
472
473
474
475
476
477
478
        if self.function.returns:
            return '\n        '.join([
                d
                for d in self.function.returns.output_declarations(self.prefix)
            ])
        else:
            return ''

    def get_result(self):
        return self.function.returns.input(self.prefix)

479
480
481
    def generate_method(self) -> str:
        if not self.function.cfunction:
            raise Exception('self.function.update() must be called')
Paul Fultz II's avatar
Paul Fultz II committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
        if self.function.returns:
            return_type = self.function.returns.get_cpp_type()
            return cpp_class_method_template.safe_substitute(
                return_type=return_type,
                name=self.name,
                cfunction=self.function.cfunction.name,
                result=self.function.returns.cpp_output(self.prefix),
                params=self.get_params(),
                outputs=self.get_return_declarations(),
                args=self.get_args(),
                success=success_type)
        else:
            return cpp_class_void_method_template.safe_substitute(
                name=self.name,
                cfunction=self.function.cfunction.name,
                params=self.get_params(),
                args=self.get_args(),
                success=success_type)

501
502
503
    def generate_constructor(self, name: str) -> str:
        if not self.function.cfunction:
            raise Exception('self.function.update() must be called')
Paul Fultz II's avatar
Paul Fultz II committed
504
505
506
507
508
509
510
511
512
        return cpp_class_constructor_template.safe_substitute(
            name=name,
            cfunction=self.function.cfunction.name,
            params=self.get_params(),
            args=self.get_args(),
            success=success_type)


class CPPClass:
513
    def __init__(self, name: str, ctype: str) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
514
515
        self.name = name
        self.ctype = ctype
516
517
        self.constructors: List[CPPMember] = []
        self.methods: List[CPPMember] = []
Paul Fultz II's avatar
Paul Fultz II committed
518
519
        self.prefix = 'p'

520
    def add_method(self, name: str, f: Function) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
521
522
        self.methods.append(CPPMember(name, f, self.prefix, method=True))

523
    def add_constructor(self, name: str, f: Function) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
524
525
        self.constructors.append(CPPMember(name, f, self.prefix, method=True))

526
    def generate_methods(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
527
528
        return '\n    '.join([m.generate_method() for m in self.methods])

529
    def generate_constructors(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
530
531
532
        return '\n    '.join(
            [m.generate_constructor(self.name) for m in self.constructors])

533
534
    def substitute(self, s: Union[string.Template, str], **kwargs) -> str:
        t = string.Template(s) if isinstance(s, str) else s
Paul Fultz II's avatar
Paul Fultz II committed
535
536
537
538
539
540
        destroy = self.ctype + '_destroy'
        return t.safe_substitute(name=self.name,
                                 ctype=self.ctype,
                                 destroy=destroy,
                                 **kwargs)

541
    def generate(self) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
542
543
544
545
546
547
        return self.substitute(
            cpp_class_template,
            constructors=self.substitute(self.generate_constructors()),
            methods=self.substitute(self.generate_methods()))


548
549
def params(virtual: Optional[Dict[str, str]] = None,
           **kwargs) -> List[Parameter]:
Paul Fultz II's avatar
Paul Fultz II committed
550
    result = []
551
552
553
    v: Dict[str, str] = virtual or {}
    for name in v:
        result.append(Parameter(name, v[name]))
Paul Fultz II's avatar
Paul Fultz II committed
554
555
556
557
558
    for name in kwargs:
        result.append(Parameter(name, kwargs[name]))
    return result


559
def add_function(name: str, *args, **kwargs) -> Function:
Paul Fultz II's avatar
Paul Fultz II committed
560
561
562
563
564
    f = Function(name, *args, **kwargs)
    functions.append(f)
    return f


565
def once(f: Callable) -> Any:
Paul Fultz II's avatar
Paul Fultz II committed
566
567
568
569
570
571
    @wraps(f)
    def decorated(*args, **kwargs):
        if not decorated.has_run:
            decorated.has_run = True
            return f(*args, **kwargs)

572
573
574
    d: Any = decorated
    d.has_run = False
    return d
Paul Fultz II's avatar
Paul Fultz II committed
575
576
577


@once
578
def process_functions() -> None:
Paul Fultz II's avatar
Paul Fultz II committed
579
580
581
582
    for f in functions:
        f.update()


583
def generate_lines(p: List[str]) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
584
585
586
    return '\n'.join(p)


587
def generate_c_header() -> str:
Paul Fultz II's avatar
Paul Fultz II committed
588
    process_functions()
589
590
591
    return generate_lines(
        c_header_preamble +
        [f.get_cfunction().generate_header() for f in functions])
Paul Fultz II's avatar
Paul Fultz II committed
592
593


594
def generate_c_api_body() -> str:
Paul Fultz II's avatar
Paul Fultz II committed
595
    process_functions()
596
597
598
    return generate_lines(
        c_api_body_preamble +
        [f.get_cfunction().generate_body() for f in functions])
Paul Fultz II's avatar
Paul Fultz II committed
599
600


601
def generate_cpp_header() -> str:
Paul Fultz II's avatar
Paul Fultz II committed
602
603
604
605
606
    process_functions()
    return generate_lines(cpp_header_preamble +
                          [c.generate() for c in cpp_classes])


607
def cwrap(name: str) -> Callable:
Paul Fultz II's avatar
Paul Fultz II committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
    def with_cwrap(f):
        type_map[name] = f

        @wraps(f)
        def decorated(*args, **kwargs):
            return f(*args, **kwargs)

        return decorated

    return with_cwrap


handle_typedef = Template('''
typedef struct ${ctype} * ${ctype}_t;
typedef const struct ${ctype} * const_${ctype}_t;
''')

handle_definition = Template('''
extern "C" struct ${ctype};
struct ${ctype} {
    template<class... Ts>
    ${ctype}(Ts&&... xs)
    : object(std::forward<Ts>(xs)...)
    {}
    ${cpptype} object;
};
''')

handle_preamble = '''
template<class T, class U, class Target=std::remove_pointer_t<T>>
Target* object_cast(U* x)
{
    return reinterpret_cast<Target*>(x);
}
template<class T, class U, class Target=std::remove_pointer_t<T>>
const Target* object_cast(const U* x)
{
    return reinterpret_cast<const Target*>(x);
}

template<class T, class... Ts, class Target=std::remove_pointer_t<T>>
Target* allocate(Ts&&... xs)
{
    return new Target(std::forward<Ts>(xs)...); // NOLINT
}

template<class T>
void destroy(T* x)
{
    delete x; // NOLINT
}
'''

cpp_handle_preamble = '''
template<class T, class Deleter, Deleter deleter>
struct handle_base
{

    template<class F, class... Ts>
    void make_handle(F f, Ts&&... xs)
    {
        T* result = nullptr;
        auto e = F(&result, std::forward<Ts>(xs)...);
        if (e != ${success})
            throw std::runtime_error("Failed to call function");
        set_handle(result);
    }

    template<class F, class... Ts>
    void call_handle(F f, Ts&&... xs)
    {
        auto e = F(this->get_handle_ptr(), std::forward<Ts>(xs)...);
        if (e != ${success})
            throw std::runtime_error("Failed to call function");
    }

    const std::shared_ptr<T>& get_handle() const
    {
        return m_handle;
    }

    T* get_handle_ptr() const
    {
        assert(m_handle != nullptr);
        return get_handle().get();
    }

    void set_handle(T* ptr, bool own = true)
    {
        if (own)
            m_handle = std::shared_ptr<T>{ptr, deleter};
        else
            m_handle = std::shared_ptr<T>{ptr, [](T*) {}};
    }

protected:
    std::shared_ptr<T> m_handle;
};

'''


@once
711
def add_handle_preamble() -> None:
Paul Fultz II's avatar
Paul Fultz II committed
712
713
714
715
716
    c_api_body_preamble.append(handle_preamble)
    cpp_header_preamble.append(
        string.Template(cpp_handle_preamble).substitute(success=success_type))


717
718
719
720
721
def add_handle(name: str,
               ctype: str,
               cpptype: str,
               destroy: Optional[str] = None,
               ref: Optional[bool] = None) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
722
    opaque_type = ctype + '_t'
723
    const_opaque_type = 'const_' + opaque_type
Paul Fultz II's avatar
Paul Fultz II committed
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746

    def handle_wrap(p):
        t = Type(opaque_type)
        if p.type.is_const():
            t = Type('const_' + opaque_type)
        if p.returns:
            p.add_param(t.add_pointer())
            if p.type.is_reference():
                p.cpp_write = '${cpptype}(${name}, false)'
                p.write = ['*${name} = object_cast<${ctype}>(&(${result}))']
            elif p.type.is_pointer():
                p.cpp_write = '${cpptype}(${name}, false)'
                p.write = ['*${name} = object_cast<${ctype}>(${result})']
            else:
                p.cpp_write = '${cpptype}(${name})'
                p.write = ['*${name} = allocate<${ctype}>(${result})']
        else:
            p.add_param(t)
            p.bad_param('${name} == nullptr', 'Null pointer')
            p.read = '${name}->object'
            p.cpp_read = '${name}.get_handle_ptr()'

    type_map[cpptype] = handle_wrap
747
748
749
750
    if not ref:
        add_function(destroy or ctype + '_' + 'destroy',
                     params({name: opaque_type}),
                     fname='destroy')
751
752
753
        add_function(ctype + '_' + 'assign_to',
                     params(output=opaque_type, input=const_opaque_type),
                     invoke='*output = *input')
Paul Fultz II's avatar
Paul Fultz II committed
754
755
756
757
758
759
    add_handle_preamble()
    c_header_preamble.append(handle_typedef.substitute(locals()))
    c_api_body_preamble.append(handle_definition.substitute(locals()))


@cwrap('std::vector')
760
761
762
763
764
765
def vector_c_wrap(p: Parameter) -> None:
    inner = p.type.inner_type()
    # Not a generic type
    if not inner:
        return
    t = inner.add_pointer()
Paul Fultz II's avatar
Paul Fultz II committed
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
    if p.returns:
        if p.type.is_reference():
            if p.type.is_const():
                t = t.add_const()
            p.add_param(t.add_pointer())
            p.add_size_param()
            p.bad_param('${name} == nullptr or ${size} == nullptr',
                        'Null pointer')
            p.cpp_write = '${type}(${name}, ${name}+${size})'
            p.write = [
                '*${name} = ${result}.data()', '*${size} = ${result}.size()'
            ]
        else:
            p.add_param(t)
            p.bad_param('${name} == nullptr', 'Null pointer')
            p.cpp_write = '${type}(${name}, ${name}+${size})'
            p.write = [
                'std::copy(${result}.begin(), ${result}.end(), ${name})'
            ]
    else:
        p.add_param(t)
        p.add_size_param()
788
        p.bad_param('${name} == nullptr and ${size} != 0', 'Null pointer')
Paul Fultz II's avatar
Paul Fultz II committed
789
790
791
        p.read = '${type}(${name}, ${name}+${size})'


792
@cwrap('std::string')
793
def string_c_wrap(p: Parameter) -> None:
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
    t = Type('char*')
    if p.returns:
        if p.type.is_reference():
            p.add_param(t.add_pointer())
            p.bad_param('${name} == nullptr', 'Null pointer')
            p.cpp_write = '${type}(${name})'
            p.write = ['*${name} = ${result}.c_str()']
        else:
            p.add_param(t)
            p.add_param('size_t', p.name + '_size')
            p.bad_param('${name} == nullptr', 'Null pointer')
            p.cpp_write = '${type}(${name})'
            p.write = [
                'auto* it = std::copy_n(${result}.begin(), std::min(${result}.size(), ${name}_size - 1), ${name});'
                '*it = \'\\0\''
            ]
    else:
        p.add_param(t)
        p.bad_param('${name} == nullptr', 'Null pointer')
        p.read = '${type}(${name})'


Paul Fultz II's avatar
Paul Fultz II committed
816
class Handle:
817
818
819
820
821
    def __init__(self,
                 name: str,
                 ctype: str,
                 cpptype: str,
                 ref: Optional[bool] = None) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
822
823
824
825
        self.name = name
        self.ctype = ctype
        self.cpptype = cpptype
        self.cpp_class = CPPClass(name, ctype)
826
        add_handle(name, ctype, cpptype, ref=ref)
Paul Fultz II's avatar
Paul Fultz II committed
827
828
        cpp_type_map[cpptype] = name

829
    def cname(self, name: str) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
830
831
        return self.ctype + '_' + name

832
    def substitute(self, s: str, **kwargs) -> str:
Paul Fultz II's avatar
Paul Fultz II committed
833
834
835
836
837
        return Template(s).safe_substitute(name=self.name,
                                           ctype=self.ctype,
                                           cpptype=self.cpptype,
                                           **kwargs)

838
839
840
841
842
843
    def constructor(self,
                    name: str,
                    params: Optional[List[Parameter]] = None,
                    fname: Optional[str] = None,
                    invoke: Optional[str] = None,
                    **kwargs) -> 'Handle':
Paul Fultz II's avatar
Paul Fultz II committed
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
        create = self.substitute('allocate<${cpptype}>($@)')
        if fname:
            create = self.substitute('allocate<${cpptype}>(${fname}($@))',
                                     fname=fname)

        f = add_function(self.cname(name),
                         params=params,
                         invoke=invoke or create,
                         returns=self.cpptype + '*',
                         return_name=self.name,
                         **kwargs)
        self.cpp_class.add_constructor(name, f)
        return self

    def method(self,
859
860
861
862
863
864
865
               name: str,
               params: Optional[List[Parameter]] = None,
               fname: Optional[str] = None,
               invoke: Optional[str] = None,
               cpp_name: Optional[str] = None,
               const: Optional[bool] = None,
               **kwargs) -> 'Handle':
Paul Fultz II's avatar
Paul Fultz II committed
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
        cpptype = self.cpptype
        if const:
            cpptype = Type(cpptype).add_const().str()
        p = Parameter(self.name, cpptype)
        args = to_template_vars(params or [])
        f = add_function(self.cname(name),
                         params=[p] + (params or []),
                         invoke=invoke
                         or self.substitute('${var}.${fname}(${args})',
                                            var=template_var(self.name),
                                            fname=fname or name,
                                            args=args),
                         **kwargs)
        self.cpp_class.add_method(cpp_name or name, f)
        return self

    def function(self, name, params=None, **kwargs):
        add_function(self.cname(name), params=params, **kwargs)
        return self

886
    def add_cpp_class(self) -> None:
Paul Fultz II's avatar
Paul Fultz II committed
887
888
889
        cpp_classes.append(self.cpp_class)


890
891
892
893
def handle(ctype: str,
           cpptype: str,
           name: Optional[str] = None,
           ref: Optional[bool] = None) -> Callable:
Paul Fultz II's avatar
Paul Fultz II committed
894
895
    def with_handle(f):
        n = name or f.__name__
896
        h = Handle(n, ctype, cpptype, ref=ref)
Paul Fultz II's avatar
Paul Fultz II committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
        f(h)
        h.add_cpp_class()

        @wraps(f)
        def decorated(*args, **kwargs):
            return f(*args, **kwargs)

        return decorated

    return with_handle


def template_eval(template, **kwargs):
    start = '<%'
    end = '%>'
    escaped = (re.escape(start), re.escape(end))
    mark = re.compile('%s(.*?)%s' % escaped, re.DOTALL)
    for key in kwargs:
        exec('%s = %s' % (key, kwargs[key]))
    for item in mark.findall(template):
        e = eval(item.strip())
        template = template.replace(start + item + end, str(e))
    return template


922
923
924
925
def run(args: List[str]) -> None:
    runpy.run_path(args[0])
    if len(args) > 1:
        f = open(args[1]).read()
Paul Fultz II's avatar
Paul Fultz II committed
926
927
928
929
930
931
932
933
934
935
        r = template_eval(f)
        sys.stdout.write(r)
    else:
        sys.stdout.write(generate_c_header())
        sys.stdout.write(generate_c_api_body())
        sys.stdout.write(generate_cpp_header())


if __name__ == "__main__":
    sys.modules['api'] = sys.modules['__main__']
936
    run(sys.argv[1:])