src/bindings/python/bt2/bt2/integer_range_set.py

   1 # SPDX-License-Identifier: MIT
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4
   5 from bt2 import native_bt, object, utils
   6 import collections.abc
   7 import bt2
   8
   9
  10 class _IntegerRangeConst:
  11     def __init__(self, lower, upper=None):
  12         self._check_type(lower)
  13
  14         if upper is None:
  15             upper = lower
  16
  17         self._check_type(upper)
  18
  19         if lower > upper:
  20             raise ValueError(
  21                 "range's lower bound ({}) is greater than its upper bound ({})".format(
  22                     lower, upper
  23                 )
  24             )
  25
  26         self._lower = lower
  27         self._upper = upper
  28
  29     @property
  30     def lower(self):
  31         return self._lower
  32
  33     @property
  34     def upper(self):
  35         return self._upper
  36
  37     def contains(self, value):
  38         self._check_type(value)
  39         return value >= self._lower and value <= self._upper
  40
  41     def __eq__(self, other):
  42         if not isinstance(other, _IntegerRangeConst):
  43             return False
  44
  45         return self.lower == other.lower and self.upper == other.upper
  46
  47
  48 class _IntegerRange(_IntegerRangeConst):
  49     def __init__(self, lower, upper=None):
  50         super().__init__(lower, upper)
  51
  52
  53 class _SignedIntegerRangeConst(_IntegerRangeConst):
  54     _is_type = staticmethod(utils._is_int64)
  55     _check_type = staticmethod(utils._check_int64)
  56
  57
  58 class SignedIntegerRange(_SignedIntegerRangeConst, _IntegerRange):
  59     pass
  60
  61
  62 class _UnsignedIntegerRangeConst(_IntegerRangeConst):
  63     _is_type = staticmethod(utils._is_uint64)
  64     _check_type = staticmethod(utils._check_uint64)
  65
  66
  67 class UnsignedIntegerRange(_UnsignedIntegerRangeConst, _IntegerRange):
  68     pass
  69
  70
  71 class _IntegerRangeSetConst(object._SharedObject, collections.abc.Set):
  72     def __len__(self):
  73         range_set_ptr = self._as_range_set_ptr(self._ptr)
  74         count = native_bt.integer_range_set_get_range_count(range_set_ptr)
  75         assert count >= 0
  76         return count
  77
  78     def __contains__(self, other_range):
  79         for rg in self:
  80             if rg == other_range:
  81                 return True
  82
  83         return False
  84
  85     def __iter__(self):
  86         for idx in range(len(self)):
  87             rg_ptr = self._borrow_range_ptr_by_index(self._ptr, idx)
  88             assert rg_ptr is not None
  89             lower = self._range_get_lower(rg_ptr)
  90             upper = self._range_get_upper(rg_ptr)
  91             yield self._range_pycls(lower, upper)
  92
  93     def __eq__(self, other):
  94
  95         if not isinstance(other, _IntegerRangeSetConst):
  96             return False
  97
  98         return self._is_equal(self._ptr, other._ptr)
  99
 100     def contains_value(self, value):
 101         for rg in self:
 102             if rg.contains(value):
 103                 return True
 104
 105         return False
 106
 107
 108 class _IntegerRangeSet(_IntegerRangeSetConst, collections.abc.MutableSet):
 109     def __init__(self, ranges=None):
 110         ptr = self._create_range_set()
 111
 112         if ptr is None:
 113             raise bt2._MemoryError("cannot create range set object")
 114
 115         super().__init__(ptr)
 116
 117         if ranges is not None:
 118             # will raise if not iterable
 119             for rg in ranges:
 120                 self.add(rg)
 121
 122     def add(self, rg):
 123         if type(rg) is not self._range_pycls:
 124             if self._range_pycls._is_type(rg):
 125                 rg = self._range_pycls(rg)
 126             else:
 127                 # assume it's a simple pair (will raise if it's not)
 128                 rg = self._range_pycls(rg[0], rg[1])
 129
 130         status = self._add_range(self._ptr, rg.lower, rg.upper)
 131         utils._handle_func_status(status, "cannot add range to range set object")
 132
 133     def discard(self, rg):
 134         raise NotImplementedError
 135
 136
 137 class _SignedIntegerRangeSetConst(_IntegerRangeSetConst):
 138     @staticmethod
 139     def _get_ref(ptr):
 140         native_bt.integer_range_set_signed_get_ref(ptr)
 141
 142     @staticmethod
 143     def _put_ref(ptr):
 144         native_bt.integer_range_set_signed_put_ref(ptr)
 145
 146     _as_range_set_ptr = staticmethod(
 147         native_bt.integer_range_set_signed_as_range_set_const
 148     )
 149     _borrow_range_ptr_by_index = staticmethod(
 150         native_bt.integer_range_set_signed_borrow_range_by_index_const
 151     )
 152     _range_get_lower = staticmethod(native_bt.integer_range_signed_get_lower)
 153     _range_get_upper = staticmethod(native_bt.integer_range_signed_get_upper)
 154     _is_equal = staticmethod(native_bt.integer_range_set_signed_is_equal)
 155     _range_pycls = _SignedIntegerRangeConst
 156
 157
 158 class SignedIntegerRangeSet(_SignedIntegerRangeSetConst, _IntegerRangeSet):
 159     _create_range_set = staticmethod(native_bt.integer_range_set_signed_create)
 160     _add_range = staticmethod(native_bt.integer_range_set_signed_add_range)
 161     _range_pycls = SignedIntegerRange
 162
 163
 164 class _UnsignedIntegerRangeSetConst(_IntegerRangeSetConst):
 165     @staticmethod
 166     def _get_ref(ptr):
 167         native_bt.integer_range_set_unsigned_get_ref(ptr)
 168
 169     @staticmethod
 170     def _put_ref(ptr):
 171         native_bt.integer_range_set_unsigned_put_ref(ptr)
 172
 173     _as_range_set_ptr = staticmethod(
 174         native_bt.integer_range_set_unsigned_as_range_set_const
 175     )
 176     _borrow_range_ptr_by_index = staticmethod(
 177         native_bt.integer_range_set_unsigned_borrow_range_by_index_const
 178     )
 179     _range_get_lower = staticmethod(native_bt.integer_range_unsigned_get_lower)
 180     _range_get_upper = staticmethod(native_bt.integer_range_unsigned_get_upper)
 181     _is_equal = staticmethod(native_bt.integer_range_set_unsigned_is_equal)
 182     _range_pycls = _UnsignedIntegerRangeConst
 183
 184
 185 class UnsignedIntegerRangeSet(_UnsignedIntegerRangeSetConst, _IntegerRangeSet):
 186     _create_range_set = staticmethod(native_bt.integer_range_set_unsigned_create)
 187     _add_range = staticmethod(native_bt.integer_range_set_unsigned_add_range)
 188     _range_pycls = UnsignedIntegerRange