pybind.py revision 14061:bd3e8e7a983d 
1# Copyright (c) 2017, 2019 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Andreas Sandberg
37
38from __future__ import print_function
39from __future__ import absolute_import
40
41from abc import *
42
43class PyBindExport(object):
44    __metaclass__ = ABCMeta
45
46    @abstractmethod
47    def export(self, code, cname):
48        pass
49
50class PyBindProperty(PyBindExport):
51    def __init__(self, name, cxx_name=None, writable=True):
52        self.name = name
53        self.cxx_name = cxx_name if cxx_name else name
54        self.writable = writable
55
56    def export(self, code, cname):
57        export = "def_readwrite" if self.writable else "def_readonly"
58        code('.${export}("${{self.name}}", &${cname}::${{self.cxx_name}})')
59
60class PyBindMethod(PyBindExport):
61    def __init__(self, name, cxx_name=None, args=None,
62                 return_value_policy=None, static=False):
63        self.name = name
64        self.cxx_name = cxx_name if cxx_name else name
65        self.args = args
66        self.return_value_policy = return_value_policy
67        self.method_def = 'def_static' if static else 'def'
68
69    def _conv_arg(self, value):
70        if isinstance(value, bool):
71            return "true" if value else "false"
72        elif isinstance(value, (float, int)):
73            return repr(value)
74        else:
75            raise TypeError("Unsupported PyBind default value type")
76
77    def export(self, code, cname):
78        arguments = [ '"${{self.name}}"', '&${cname}::${{self.cxx_name}}' ]
79        if self.return_value_policy:
80            arguments.append('pybind11::return_value_policy::'
81                             '${{self.return_value_policy}}')
82        if self.args:
83            def get_arg_decl(arg):
84                if isinstance(arg, tuple):
85                    name, default = arg
86                    return 'py::arg("%s") = %s' % (
87                        name, self._conv_arg(default))
88                else:
89                    return 'py::arg("%s")' % arg
90
91            arguments.extend(list([ get_arg_decl(a) for a in self.args ]))
92        code('.' + self.method_def + '(' + ', '.join(arguments) + ')')
93