bindings/python/bt2/object.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt
  24 import abc
  25
  26
  27 class _Object:
  28     def __init__(self, ptr):
  29         self._ptr = ptr
  30
  31     @property
  32     def addr(self):
  33         return int(self._ptr)
  34
  35     @classmethod
  36     def _create_from_ptr(cls, ptr):
  37         obj = cls.__new__(cls)
  38         obj._ptr = ptr
  39         return obj
  40
  41     def _get(self):
  42         native_bt.get(self._ptr)
  43
  44     def __del__(self):
  45         ptr = getattr(self, '_ptr', None)
  46         native_bt.put(ptr)
  47         self._ptr = None
  48
  49     def __repr__(self):
  50         return '<{}.{} object @ {}>'.format(self.__class__.__module__,
  51                                             self.__class__.__name__,
  52                                             hex(self.addr))
  53
  54
  55 class _PrivateObject:
  56     def __del__(self):
  57         pub_ptr = getattr(self, '_pub_ptr', None)
  58         native_bt.put(pub_ptr)
  59         self._pub_ptr = None
  60         super().__del__()
  61
  62
  63 class _Freezable(metaclass=abc.ABCMeta):
  64     @property
  65     def is_frozen(self):
  66         return self._is_frozen()
  67
  68     @property
  69     def frozen(self):
  70         return self.is_frozen
  71
  72     def freeze(self):
  73         self._freeze()
  74
  75     @abc.abstractmethod
  76     def _is_frozen(self):
  77         pass
  78
  79     @abc.abstractmethod
  80     def _freeze(self):
  81         pass