src/python/m5/util/pybind.py

   1 # Copyright (c) 2017 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
  38 from abc import *
  39
  40 class PyBindExport(object):
  41     __metaclass__ = ABCMeta
  42
  43     @abstractmethod
  44     def export(self, code, cname):
  45         pass
  46
  47 class PyBindProperty(PyBindExport):
  48     def __init__(self, name, cxx_name=None, writable=True):
  49         self.name = name
  50         self.cxx_name = cxx_name if cxx_name else name
  51         self.writable = writable
  52
  53     def export(self, code, cname):
  54         export = "def_readwrite" if self.writable else "def_readonly"
  55         code('.${export}("${{self.name}}", &${cname}::${{self.cxx_name}})')
  56
  57 class PyBindMethod(PyBindExport):
  58     def __init__(self, name, cxx_name=None, args=None):
  59         self.name = name
  60         self.cxx_name = cxx_name if cxx_name else name
  61         self.args = args
  62
  63     def _conv_arg(self, value):
  64         if isinstance(value, bool):
  65             return "true" if value else "false"
  66         elif isinstance(value, float, int):
  67             return repr(value)
  68         else:
  69             raise TypeError("Unsupported PyBind default value type")
  70
  71     def export(self, code, cname):
  72         if self.args:
  73             def get_arg_decl(arg):
  74                 if isinstance(arg, tuple):
  75                     name, default = arg
  76                     return 'py::arg("%s") = %s' % (
  77                         name, self._conv_arg(default))
  78                 else:
  79                     return 'py::arg("%s")' % arg
  80
  81             code('.def("${{self.name}}", &${cname}::${{self.name}}, ')
  82             code('    ' + \
  83                  ', '.join([ get_arg_decl(a) for a in self.args ]) + ')')
  84         else:
  85             code('.def("${{self.name}}", &${cname}::${{self.cxx_name}})')