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