Commit | Line | Data |
---|---|---|
0235b0db | 1 | # SPDX-License-Identifier: MIT |
81447b5b | 2 | # |
811644b8 | 3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> |
81447b5b | 4 | |
e5914347 SM |
5 | from bt2 import native_bt |
6 | from bt2 import object as bt2_object | |
7 | from bt2 import utils as bt2_utils | |
c345b078 | 8 | from bt2 import error as bt2_error |
81447b5b PP |
9 | import collections.abc |
10 | import functools | |
11 | import numbers | |
12 | import math | |
13 | import abc | |
81447b5b PP |
14 | |
15 | ||
e42e1587 | 16 | def _create_from_ptr_template(ptr, object_map): |
b5947615 SM |
17 | if ptr is None: |
18 | return | |
19 | ||
20 | # bt_value_null is translated to None. However, we are given a reference | |
21 | # to it that we are not going to manage anymore, since we don't create a | |
22 | # Python wrapper for it. Therefore put that reference immediately. | |
23 | if ptr == native_bt.value_null: | |
3fb99a22 | 24 | _Value._put_ref(ptr) |
81447b5b PP |
25 | return |
26 | ||
27 | typeid = native_bt.value_get_type(ptr) | |
e42e1587 | 28 | return object_map[typeid]._create_from_ptr(ptr) |
81447b5b PP |
29 | |
30 | ||
e42e1587 FD |
31 | def _create_from_ptr(ptr): |
32 | return _create_from_ptr_template(ptr, _TYPE_TO_OBJ) | |
33 | ||
34 | ||
35 | def _create_from_const_ptr(ptr): | |
36 | return _create_from_ptr_template(ptr, _TYPE_TO_CONST_OBJ) | |
37 | ||
38 | ||
39 | def _create_from_ptr_and_get_ref_template(ptr, object_map): | |
10a19b49 SM |
40 | if ptr is None or ptr == native_bt.value_null: |
41 | return | |
42 | ||
43 | typeid = native_bt.value_get_type(ptr) | |
e42e1587 FD |
44 | return object_map[typeid]._create_from_ptr_and_get_ref(ptr) |
45 | ||
46 | ||
47 | def _create_from_ptr_and_get_ref(ptr): | |
48 | return _create_from_ptr_and_get_ref_template(ptr, _TYPE_TO_OBJ) | |
49 | ||
50 | ||
51 | def _create_from_const_ptr_and_get_ref(ptr): | |
52 | return _create_from_ptr_and_get_ref_template(ptr, _TYPE_TO_CONST_OBJ) | |
10a19b49 SM |
53 | |
54 | ||
81447b5b PP |
55 | def create_value(value): |
56 | if value is None: | |
57 | # null value object | |
58 | return | |
59 | ||
60 | if isinstance(value, _Value): | |
61 | return value | |
62 | ||
63 | if isinstance(value, bool): | |
64 | return BoolValue(value) | |
65 | ||
665658c2 | 66 | if isinstance(value, numbers.Integral): |
fdd3a2da | 67 | return SignedIntegerValue(value) |
81447b5b | 68 | |
665658c2 | 69 | if isinstance(value, numbers.Real): |
10a19b49 | 70 | return RealValue(value) |
81447b5b PP |
71 | |
72 | if isinstance(value, str): | |
73 | return StringValue(value) | |
74 | ||
665658c2 | 75 | if isinstance(value, collections.abc.Sequence): |
81447b5b | 76 | return ArrayValue(value) |
665658c2 PP |
77 | |
78 | if isinstance(value, collections.abc.Mapping): | |
79 | return MapValue(value) | |
81447b5b | 80 | |
cfbd7cf3 FD |
81 | raise TypeError( |
82 | "cannot create value object from '{}' object".format(value.__class__.__name__) | |
83 | ) | |
81447b5b PP |
84 | |
85 | ||
e5914347 | 86 | class _ValueConst(bt2_object._SharedObject, metaclass=abc.ABCMeta): |
9dee90bd SM |
87 | @staticmethod |
88 | def _get_ref(ptr): | |
89 | native_bt.value_get_ref(ptr) | |
90 | ||
91 | @staticmethod | |
92 | def _put_ref(ptr): | |
93 | native_bt.value_put_ref(ptr) | |
94 | ||
e42e1587 FD |
95 | _create_value_from_ptr = staticmethod(_create_from_const_ptr) |
96 | _create_value_from_ptr_and_get_ref = staticmethod( | |
97 | _create_from_const_ptr_and_get_ref | |
98 | ) | |
10a19b49 | 99 | |
81447b5b PP |
100 | def __ne__(self, other): |
101 | return not (self == other) | |
102 | ||
81447b5b PP |
103 | def _check_create_status(self, ptr): |
104 | if ptr is None: | |
c345b078 | 105 | raise bt2_error._MemoryError( |
f5567ea8 | 106 | "cannot create {} value object".format(self._NAME.lower()) |
cfbd7cf3 | 107 | ) |
81447b5b PP |
108 | |
109 | ||
e42e1587 FD |
110 | class _Value(_ValueConst): |
111 | _create_value_from_ptr = staticmethod(_create_from_ptr) | |
112 | _create_value_from_ptr_and_get_ref = staticmethod(_create_from_ptr_and_get_ref) | |
113 | ||
114 | ||
81447b5b | 115 | @functools.total_ordering |
e42e1587 | 116 | class _NumericValueConst(_ValueConst): |
81447b5b PP |
117 | @staticmethod |
118 | def _extract_value(other): | |
e42e1587 | 119 | if isinstance(other, _BoolValueConst) or isinstance(other, bool): |
b00a769c | 120 | return bool(other) |
81447b5b PP |
121 | |
122 | if isinstance(other, numbers.Integral): | |
123 | return int(other) | |
124 | ||
125 | if isinstance(other, numbers.Real): | |
126 | return float(other) | |
127 | ||
128 | if isinstance(other, numbers.Complex): | |
129 | return complex(other) | |
130 | ||
cfbd7cf3 FD |
131 | raise TypeError( |
132 | "'{}' object is not a number object".format(other.__class__.__name__) | |
133 | ) | |
81447b5b PP |
134 | |
135 | def __int__(self): | |
9b6cd4a7 | 136 | return int(self._value) |
81447b5b PP |
137 | |
138 | def __float__(self): | |
9b6cd4a7 | 139 | return float(self._value) |
81447b5b | 140 | |
83656269 JG |
141 | def __repr__(self): |
142 | return repr(self._value) | |
81447b5b PP |
143 | |
144 | def __lt__(self, other): | |
09a926c1 | 145 | return self._value < self._extract_value(other) |
81447b5b | 146 | |
81447b5b | 147 | def __eq__(self, other): |
b00a769c PP |
148 | try: |
149 | return self._value == self._extract_value(other) | |
4c4935bf | 150 | except Exception: |
81447b5b PP |
151 | return False |
152 | ||
81447b5b | 153 | def __rmod__(self, other): |
9b6cd4a7 | 154 | return self._extract_value(other) % self._value |
81447b5b PP |
155 | |
156 | def __mod__(self, other): | |
9b6cd4a7 | 157 | return self._value % self._extract_value(other) |
81447b5b PP |
158 | |
159 | def __rfloordiv__(self, other): | |
9b6cd4a7 | 160 | return self._extract_value(other) // self._value |
81447b5b PP |
161 | |
162 | def __floordiv__(self, other): | |
9b6cd4a7 | 163 | return self._value // self._extract_value(other) |
81447b5b PP |
164 | |
165 | def __round__(self, ndigits=None): | |
166 | if ndigits is None: | |
9b6cd4a7 | 167 | return round(self._value) |
81447b5b | 168 | else: |
9b6cd4a7 | 169 | return round(self._value, ndigits) |
81447b5b PP |
170 | |
171 | def __ceil__(self): | |
9b6cd4a7 | 172 | return math.ceil(self._value) |
81447b5b PP |
173 | |
174 | def __floor__(self): | |
9b6cd4a7 | 175 | return math.floor(self._value) |
81447b5b PP |
176 | |
177 | def __trunc__(self): | |
9b6cd4a7 | 178 | return int(self._value) |
81447b5b PP |
179 | |
180 | def __abs__(self): | |
9b6cd4a7 | 181 | return abs(self._value) |
81447b5b PP |
182 | |
183 | def __add__(self, other): | |
9b6cd4a7 | 184 | return self._value + self._extract_value(other) |
81447b5b PP |
185 | |
186 | def __radd__(self, other): | |
187 | return self.__add__(other) | |
188 | ||
189 | def __neg__(self): | |
9b6cd4a7 | 190 | return -self._value |
81447b5b PP |
191 | |
192 | def __pos__(self): | |
9b6cd4a7 | 193 | return +self._value |
81447b5b PP |
194 | |
195 | def __mul__(self, other): | |
9b6cd4a7 | 196 | return self._value * self._extract_value(other) |
81447b5b PP |
197 | |
198 | def __rmul__(self, other): | |
199 | return self.__mul__(other) | |
200 | ||
201 | def __truediv__(self, other): | |
9b6cd4a7 | 202 | return self._value / self._extract_value(other) |
81447b5b PP |
203 | |
204 | def __rtruediv__(self, other): | |
9b6cd4a7 | 205 | return self._extract_value(other) / self._value |
81447b5b PP |
206 | |
207 | def __pow__(self, exponent): | |
9b6cd4a7 | 208 | return self._value ** self._extract_value(exponent) |
81447b5b PP |
209 | |
210 | def __rpow__(self, base): | |
9b6cd4a7 | 211 | return self._extract_value(base) ** self._value |
81447b5b | 212 | |
81447b5b | 213 | |
e42e1587 FD |
214 | class _NumericValue(_NumericValueConst, _Value): |
215 | pass | |
216 | ||
217 | ||
218 | class _IntegralValueConst(_NumericValueConst, numbers.Integral): | |
81447b5b | 219 | def __lshift__(self, other): |
9b6cd4a7 | 220 | return self._value << self._extract_value(other) |
81447b5b PP |
221 | |
222 | def __rlshift__(self, other): | |
9b6cd4a7 | 223 | return self._extract_value(other) << self._value |
81447b5b PP |
224 | |
225 | def __rshift__(self, other): | |
9b6cd4a7 | 226 | return self._value >> self._extract_value(other) |
81447b5b PP |
227 | |
228 | def __rrshift__(self, other): | |
9b6cd4a7 | 229 | return self._extract_value(other) >> self._value |
81447b5b PP |
230 | |
231 | def __and__(self, other): | |
9b6cd4a7 | 232 | return self._value & self._extract_value(other) |
81447b5b PP |
233 | |
234 | def __rand__(self, other): | |
9b6cd4a7 | 235 | return self._extract_value(other) & self._value |
81447b5b PP |
236 | |
237 | def __xor__(self, other): | |
9b6cd4a7 | 238 | return self._value ^ self._extract_value(other) |
81447b5b PP |
239 | |
240 | def __rxor__(self, other): | |
9b6cd4a7 | 241 | return self._extract_value(other) ^ self._value |
81447b5b PP |
242 | |
243 | def __or__(self, other): | |
9b6cd4a7 | 244 | return self._value | self._extract_value(other) |
81447b5b PP |
245 | |
246 | def __ror__(self, other): | |
9b6cd4a7 | 247 | return self._extract_value(other) | self._value |
81447b5b PP |
248 | |
249 | def __invert__(self): | |
9b6cd4a7 | 250 | return ~self._value |
81447b5b | 251 | |
81447b5b | 252 | |
e42e1587 | 253 | class _IntegralValue(_IntegralValueConst, _NumericValue): |
81447b5b PP |
254 | pass |
255 | ||
256 | ||
e42e1587 | 257 | class _BoolValueConst(_IntegralValueConst): |
f5567ea8 | 258 | _NAME = "Const boolean" |
e42e1587 FD |
259 | |
260 | def __bool__(self): | |
261 | return self._value | |
262 | ||
263 | def __repr__(self): | |
264 | return repr(self._value) | |
265 | ||
266 | @property | |
267 | def _value(self): | |
268 | value = native_bt.value_bool_get(self._ptr) | |
269 | return value != 0 | |
270 | ||
271 | ||
272 | class BoolValue(_BoolValueConst, _IntegralValue): | |
f5567ea8 | 273 | _NAME = "Boolean" |
81447b5b PP |
274 | |
275 | def __init__(self, value=None): | |
276 | if value is None: | |
277 | ptr = native_bt.value_bool_create() | |
278 | else: | |
279 | ptr = native_bt.value_bool_create_init(self._value_to_bool(value)) | |
280 | ||
281 | self._check_create_status(ptr) | |
282 | super().__init__(ptr) | |
283 | ||
e42e1587 FD |
284 | @classmethod |
285 | def _value_to_bool(cls, value): | |
286 | if isinstance(value, _BoolValueConst): | |
9b6cd4a7 | 287 | value = value._value |
81447b5b PP |
288 | |
289 | if not isinstance(value, bool): | |
cfbd7cf3 | 290 | raise TypeError( |
e42e1587 | 291 | "'{}' object is not a 'bool', 'BoolValue', or '_BoolValueConst' object".format( |
cfbd7cf3 FD |
292 | value.__class__ |
293 | ) | |
294 | ) | |
81447b5b | 295 | |
b00a769c | 296 | return value |
81447b5b | 297 | |
9b6cd4a7 | 298 | def _set_value(self, value): |
10a19b49 | 299 | native_bt.value_bool_set(self._ptr, self._value_to_bool(value)) |
81447b5b | 300 | |
9b6cd4a7 PP |
301 | value = property(fset=_set_value) |
302 | ||
81447b5b | 303 | |
e42e1587 FD |
304 | class _IntegerValueConst(_IntegralValueConst): |
305 | @property | |
306 | def _value(self): | |
307 | return self._get_value(self._ptr) | |
308 | ||
309 | ||
310 | class _IntegerValue(_IntegerValueConst, _IntegralValue): | |
81447b5b PP |
311 | def __init__(self, value=None): |
312 | if value is None: | |
fdd3a2da | 313 | ptr = self._create_default_value() |
81447b5b | 314 | else: |
fdd3a2da | 315 | ptr = self._create_value(self._value_to_int(value)) |
81447b5b PP |
316 | |
317 | self._check_create_status(ptr) | |
318 | super().__init__(ptr) | |
319 | ||
e42e1587 FD |
320 | @classmethod |
321 | def _value_to_int(cls, value): | |
e502b15a | 322 | if not isinstance(value, numbers.Integral): |
f5567ea8 | 323 | raise TypeError("expecting an integral number object") |
81447b5b PP |
324 | |
325 | value = int(value) | |
e42e1587 | 326 | cls._check_int_range(value) |
81447b5b PP |
327 | return value |
328 | ||
fdd3a2da PP |
329 | def _prop_set_value(self, value): |
330 | self._set_value(self._ptr, self._value_to_int(value)) | |
81447b5b | 331 | |
fdd3a2da PP |
332 | value = property(fset=_prop_set_value) |
333 | ||
334 | ||
e42e1587 | 335 | class _UnsignedIntegerValueConst(_IntegerValueConst): |
f5567ea8 | 336 | _NAME = "Const unsigned integer" |
e42e1587 FD |
337 | _get_value = staticmethod(native_bt.value_integer_unsigned_get) |
338 | ||
339 | ||
340 | class UnsignedIntegerValue(_UnsignedIntegerValueConst, _IntegerValue): | |
f5567ea8 | 341 | _NAME = "Unsigned integer" |
e5914347 | 342 | _check_int_range = staticmethod(bt2_utils._check_uint64) |
9c08c816 PP |
343 | _create_default_value = staticmethod(native_bt.value_integer_unsigned_create) |
344 | _create_value = staticmethod(native_bt.value_integer_unsigned_create_init) | |
345 | _set_value = staticmethod(native_bt.value_integer_unsigned_set) | |
fdd3a2da PP |
346 | |
347 | ||
e42e1587 | 348 | class _SignedIntegerValueConst(_IntegerValueConst): |
f5567ea8 | 349 | _NAME = "Const signed integer" |
e42e1587 FD |
350 | _get_value = staticmethod(native_bt.value_integer_signed_get) |
351 | ||
352 | ||
353 | class SignedIntegerValue(_SignedIntegerValueConst, _IntegerValue): | |
f5567ea8 | 354 | _NAME = "Signed integer" |
e5914347 | 355 | _check_int_range = staticmethod(bt2_utils._check_int64) |
9c08c816 PP |
356 | _create_default_value = staticmethod(native_bt.value_integer_signed_create) |
357 | _create_value = staticmethod(native_bt.value_integer_signed_create_init) | |
358 | _set_value = staticmethod(native_bt.value_integer_signed_set) | |
9b6cd4a7 | 359 | |
81447b5b | 360 | |
e42e1587 | 361 | class _RealValueConst(_NumericValueConst, numbers.Real): |
f5567ea8 | 362 | _NAME = "Const real number" |
e42e1587 FD |
363 | |
364 | @property | |
365 | def _value(self): | |
366 | return native_bt.value_real_get(self._ptr) | |
367 | ||
368 | ||
369 | class RealValue(_RealValueConst, _NumericValue): | |
f5567ea8 | 370 | _NAME = "Real number" |
81447b5b PP |
371 | |
372 | def __init__(self, value=None): | |
373 | if value is None: | |
10a19b49 | 374 | ptr = native_bt.value_real_create() |
81447b5b PP |
375 | else: |
376 | value = self._value_to_float(value) | |
10a19b49 | 377 | ptr = native_bt.value_real_create_init(value) |
81447b5b PP |
378 | |
379 | self._check_create_status(ptr) | |
380 | super().__init__(ptr) | |
381 | ||
e42e1587 FD |
382 | @classmethod |
383 | def _value_to_float(cls, value): | |
81447b5b PP |
384 | if not isinstance(value, numbers.Real): |
385 | raise TypeError("expecting a real number object") | |
386 | ||
387 | return float(value) | |
388 | ||
9b6cd4a7 | 389 | def _set_value(self, value): |
10a19b49 | 390 | native_bt.value_real_set(self._ptr, self._value_to_float(value)) |
81447b5b | 391 | |
9b6cd4a7 PP |
392 | value = property(fset=_set_value) |
393 | ||
81447b5b PP |
394 | |
395 | @functools.total_ordering | |
e42e1587 | 396 | class _StringValueConst(collections.abc.Sequence, _Value): |
f5567ea8 | 397 | _NAME = "Const string" |
81447b5b | 398 | |
e42e1587 FD |
399 | @classmethod |
400 | def _value_to_str(cls, value): | |
401 | if isinstance(value, _StringValueConst): | |
9b6cd4a7 | 402 | value = value._value |
81447b5b | 403 | |
e5914347 | 404 | bt2_utils._check_str(value) |
81447b5b PP |
405 | return value |
406 | ||
407 | @property | |
9b6cd4a7 | 408 | def _value(self): |
10a19b49 | 409 | return native_bt.value_string_get(self._ptr) |
81447b5b | 410 | |
b00a769c | 411 | def __eq__(self, other): |
81447b5b | 412 | try: |
9b6cd4a7 | 413 | return self._value == self._value_to_str(other) |
4c4935bf | 414 | except Exception: |
b00a769c | 415 | return False |
81447b5b | 416 | |
81447b5b | 417 | def __lt__(self, other): |
9b6cd4a7 | 418 | return self._value < self._value_to_str(other) |
81447b5b PP |
419 | |
420 | def __bool__(self): | |
9b6cd4a7 | 421 | return bool(self._value) |
81447b5b | 422 | |
83656269 | 423 | def __repr__(self): |
10a19b49 | 424 | return repr(self._value) |
83656269 | 425 | |
81447b5b | 426 | def __str__(self): |
9b6cd4a7 | 427 | return self._value |
81447b5b PP |
428 | |
429 | def __getitem__(self, index): | |
9b6cd4a7 | 430 | return self._value[index] |
81447b5b PP |
431 | |
432 | def __len__(self): | |
9b6cd4a7 | 433 | return len(self._value) |
81447b5b | 434 | |
5cf62322 FD |
435 | def __contains__(self, item): |
436 | return self._value_to_str(item) in self._value | |
437 | ||
e42e1587 FD |
438 | |
439 | class StringValue(_StringValueConst, _Value): | |
f5567ea8 | 440 | _NAME = "String" |
e42e1587 FD |
441 | |
442 | def __init__(self, value=None): | |
443 | if value is None: | |
444 | ptr = native_bt.value_string_create() | |
445 | else: | |
446 | ptr = native_bt.value_string_create_init(self._value_to_str(value)) | |
447 | ||
448 | self._check_create_status(ptr) | |
449 | super().__init__(ptr) | |
450 | ||
451 | def _set_value(self, value): | |
452 | status = native_bt.value_string_set(self._ptr, self._value_to_str(value)) | |
e5914347 | 453 | bt2_utils._handle_func_status(status) |
e42e1587 FD |
454 | |
455 | value = property(fset=_set_value) | |
456 | ||
81447b5b | 457 | def __iadd__(self, value): |
9b6cd4a7 | 458 | curvalue = self._value |
81447b5b PP |
459 | curvalue += self._value_to_str(value) |
460 | self.value = curvalue | |
461 | return self | |
462 | ||
463 | ||
e42e1587 | 464 | class _ContainerConst: |
81447b5b PP |
465 | def __bool__(self): |
466 | return len(self) != 0 | |
467 | ||
e42e1587 FD |
468 | |
469 | class _Container(_ContainerConst): | |
81447b5b PP |
470 | def __delitem__(self, index): |
471 | raise NotImplementedError | |
472 | ||
473 | ||
e42e1587 | 474 | class _ArrayValueConst(_ContainerConst, collections.abc.Sequence, _ValueConst): |
f5567ea8 | 475 | _NAME = "Const array" |
e42e1587 FD |
476 | _borrow_element_by_index = staticmethod( |
477 | native_bt.value_array_borrow_element_by_index_const | |
478 | ) | |
479 | _is_const = True | |
81447b5b | 480 | |
b00a769c PP |
481 | def __eq__(self, other): |
482 | if not isinstance(other, collections.abc.Sequence): | |
483 | return False | |
81447b5b | 484 | |
b00a769c PP |
485 | if len(self) != len(other): |
486 | # early mismatch | |
487 | return False | |
81447b5b | 488 | |
b00a769c PP |
489 | for self_elem, other_elem in zip(self, other): |
490 | if self_elem != other_elem: | |
491 | return False | |
492 | ||
493 | return True | |
81447b5b PP |
494 | |
495 | def __len__(self): | |
393729a6 | 496 | size = native_bt.value_array_get_length(self._ptr) |
cfbd7cf3 | 497 | assert size >= 0 |
81447b5b PP |
498 | return size |
499 | ||
500 | def _check_index(self, index): | |
501 | # TODO: support slices also | |
502 | if not isinstance(index, numbers.Integral): | |
cfbd7cf3 FD |
503 | raise TypeError( |
504 | "'{}' object is not an integral number object: invalid index".format( | |
505 | index.__class__.__name__ | |
506 | ) | |
507 | ) | |
81447b5b PP |
508 | |
509 | index = int(index) | |
510 | ||
511 | if index < 0 or index >= len(self): | |
f5567ea8 | 512 | raise IndexError("array value object index is out of range") |
81447b5b PP |
513 | |
514 | def __getitem__(self, index): | |
515 | self._check_index(index) | |
e42e1587 | 516 | ptr = self._borrow_element_by_index(self._ptr, index) |
cfbd7cf3 | 517 | assert ptr |
e42e1587 FD |
518 | return self._create_value_from_ptr_and_get_ref(ptr) |
519 | ||
520 | def __repr__(self): | |
f5567ea8 | 521 | return "[{}]".format(", ".join([repr(v) for v in self])) |
e42e1587 FD |
522 | |
523 | ||
524 | class ArrayValue(_ArrayValueConst, _Container, collections.abc.MutableSequence, _Value): | |
f5567ea8 | 525 | _NAME = "Array" |
e42e1587 FD |
526 | _borrow_element_by_index = staticmethod( |
527 | native_bt.value_array_borrow_element_by_index | |
528 | ) | |
529 | ||
530 | def __init__(self, value=None): | |
531 | ptr = native_bt.value_array_create() | |
532 | self._check_create_status(ptr) | |
533 | super().__init__(ptr) | |
534 | ||
535 | # Python will raise a TypeError if there's anything wrong with | |
536 | # the iterable protocol. | |
537 | if value is not None: | |
538 | for elem in value: | |
539 | self.append(elem) | |
81447b5b PP |
540 | |
541 | def __setitem__(self, index, value): | |
542 | self._check_index(index) | |
543 | value = create_value(value) | |
544 | ||
545 | if value is None: | |
546 | ptr = native_bt.value_null | |
547 | else: | |
548 | ptr = value._ptr | |
549 | ||
cfbd7cf3 | 550 | status = native_bt.value_array_set_element_by_index(self._ptr, index, ptr) |
e5914347 | 551 | bt2_utils._handle_func_status(status) |
81447b5b PP |
552 | |
553 | def append(self, value): | |
554 | value = create_value(value) | |
555 | ||
556 | if value is None: | |
557 | ptr = native_bt.value_null | |
558 | else: | |
559 | ptr = value._ptr | |
560 | ||
10a19b49 | 561 | status = native_bt.value_array_append_element(self._ptr, ptr) |
e5914347 | 562 | bt2_utils._handle_func_status(status) |
81447b5b PP |
563 | |
564 | def __iadd__(self, iterable): | |
565 | # Python will raise a TypeError if there's anything wrong with | |
566 | # the iterable protocol. | |
567 | for elem in iterable: | |
568 | self.append(elem) | |
569 | ||
570 | return self | |
571 | ||
81447b5b PP |
572 | def insert(self, value): |
573 | raise NotImplementedError | |
574 | ||
575 | ||
576 | class _MapValueKeyIterator(collections.abc.Iterator): | |
577 | def __init__(self, map_obj): | |
578 | self._map_obj = map_obj | |
579 | self._at = 0 | |
10a19b49 | 580 | keys_ptr = native_bt.value_map_get_keys(map_obj._ptr) |
81447b5b PP |
581 | |
582 | if keys_ptr is None: | |
f5567ea8 | 583 | raise RuntimeError("unexpected error: cannot get map value object keys") |
81447b5b PP |
584 | |
585 | self._keys = _create_from_ptr(keys_ptr) | |
586 | ||
587 | def __next__(self): | |
588 | if self._at == len(self._map_obj): | |
589 | raise StopIteration | |
590 | ||
591 | key = self._keys[self._at] | |
592 | self._at += 1 | |
593 | return str(key) | |
594 | ||
595 | ||
e42e1587 | 596 | class _MapValueConst(_ContainerConst, collections.abc.Mapping, _ValueConst): |
f5567ea8 | 597 | _NAME = "Const map" |
e42e1587 | 598 | _borrow_entry_value_ptr = staticmethod(native_bt.value_map_borrow_entry_value_const) |
81447b5b | 599 | |
81447b5b PP |
600 | def __ne__(self, other): |
601 | return _Value.__ne__(self, other) | |
602 | ||
b00a769c PP |
603 | def __eq__(self, other): |
604 | if not isinstance(other, collections.abc.Mapping): | |
605 | return False | |
81447b5b | 606 | |
b00a769c PP |
607 | if len(self) != len(other): |
608 | # early mismatch | |
609 | return False | |
81447b5b | 610 | |
b00a769c PP |
611 | for self_key in self: |
612 | if self_key not in other: | |
613 | return False | |
81447b5b | 614 | |
b00a769c PP |
615 | if self[self_key] != other[self_key]: |
616 | return False | |
81447b5b | 617 | |
b00a769c | 618 | return True |
81447b5b PP |
619 | |
620 | def __len__(self): | |
10a19b49 | 621 | size = native_bt.value_map_get_size(self._ptr) |
cfbd7cf3 | 622 | assert size >= 0 |
81447b5b PP |
623 | return size |
624 | ||
625 | def __contains__(self, key): | |
626 | self._check_key_type(key) | |
10a19b49 | 627 | return native_bt.value_map_has_entry(self._ptr, key) |
81447b5b PP |
628 | |
629 | def _check_key_type(self, key): | |
e5914347 | 630 | bt2_utils._check_str(key) |
81447b5b PP |
631 | |
632 | def _check_key(self, key): | |
633 | if key not in self: | |
634 | raise KeyError(key) | |
635 | ||
636 | def __getitem__(self, key): | |
637 | self._check_key(key) | |
e42e1587 | 638 | ptr = self._borrow_entry_value_ptr(self._ptr, key) |
cfbd7cf3 | 639 | assert ptr |
e42e1587 | 640 | return self._create_value_from_ptr_and_get_ref(ptr) |
81447b5b PP |
641 | |
642 | def __iter__(self): | |
643 | return _MapValueKeyIterator(self) | |
644 | ||
e42e1587 | 645 | def __repr__(self): |
f5567ea8 FD |
646 | items = ["{}: {}".format(repr(k), repr(v)) for k, v in self.items()] |
647 | return "{{{}}}".format(", ".join(items)) | |
e42e1587 FD |
648 | |
649 | ||
650 | class MapValue(_MapValueConst, _Container, collections.abc.MutableMapping, _Value): | |
f5567ea8 | 651 | _NAME = "Map" |
e42e1587 FD |
652 | _borrow_entry_value_ptr = staticmethod(native_bt.value_map_borrow_entry_value) |
653 | ||
654 | def __init__(self, value=None): | |
655 | ptr = native_bt.value_map_create() | |
656 | self._check_create_status(ptr) | |
657 | super().__init__(ptr) | |
658 | ||
659 | # Python will raise a TypeError if there's anything wrong with | |
660 | # the iterable/mapping protocol. | |
661 | if value is not None: | |
662 | for key, elem in value.items(): | |
663 | self[key] = elem | |
664 | ||
81447b5b PP |
665 | def __setitem__(self, key, value): |
666 | self._check_key_type(key) | |
667 | value = create_value(value) | |
668 | ||
669 | if value is None: | |
670 | ptr = native_bt.value_null | |
671 | else: | |
672 | ptr = value._ptr | |
673 | ||
10a19b49 | 674 | status = native_bt.value_map_insert_entry(self._ptr, key, ptr) |
e5914347 | 675 | bt2_utils._handle_func_status(status) |
81447b5b | 676 | |
81447b5b PP |
677 | |
678 | _TYPE_TO_OBJ = { | |
679 | native_bt.VALUE_TYPE_BOOL: BoolValue, | |
fdd3a2da PP |
680 | native_bt.VALUE_TYPE_UNSIGNED_INTEGER: UnsignedIntegerValue, |
681 | native_bt.VALUE_TYPE_SIGNED_INTEGER: SignedIntegerValue, | |
10a19b49 | 682 | native_bt.VALUE_TYPE_REAL: RealValue, |
81447b5b PP |
683 | native_bt.VALUE_TYPE_STRING: StringValue, |
684 | native_bt.VALUE_TYPE_ARRAY: ArrayValue, | |
685 | native_bt.VALUE_TYPE_MAP: MapValue, | |
686 | } | |
e42e1587 FD |
687 | |
688 | _TYPE_TO_CONST_OBJ = { | |
689 | native_bt.VALUE_TYPE_BOOL: _BoolValueConst, | |
690 | native_bt.VALUE_TYPE_UNSIGNED_INTEGER: _UnsignedIntegerValueConst, | |
691 | native_bt.VALUE_TYPE_SIGNED_INTEGER: _SignedIntegerValueConst, | |
692 | native_bt.VALUE_TYPE_REAL: _RealValueConst, | |
693 | native_bt.VALUE_TYPE_STRING: _StringValueConst, | |
694 | native_bt.VALUE_TYPE_ARRAY: _ArrayValueConst, | |
695 | native_bt.VALUE_TYPE_MAP: _MapValueConst, | |
696 | } |