lib: pass config objects to component init methods
[babeltrace.git] / src / bindings / python / bt2 / bt2 / component.py
CommitLineData
81447b5b
PP
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
23from bt2 import native_bt, object, utils
3fb99a22 24from bt2 import message_iterator as bt2_message_iterator
81447b5b 25import collections.abc
3fb99a22
PP
26from bt2 import value as bt2_value
27from bt2 import trace_class as bt2_trace_class
28from bt2 import clock_class as bt2_clock_class
29from bt2 import query_executor as bt2_query_executor
3fb99a22 30from bt2 import port as bt2_port
40910fbb 31import sys
81447b5b 32import bt2
811644b8
PP
33
34
81447b5b
PP
35# This class wraps a component class pointer. This component class could
36# have been created by Python code, but since we only have the pointer,
37# we can only wrap it in a generic way and lose the original Python
38# class.
601c0026
SM
39#
40# Subclasses must implement some methods that this base class uses:
41#
85906b6b 42# - _bt_as_component_class_ptr: static method, convert the passed component class
601c0026
SM
43# pointer to a 'bt_component_class *'.
44
cfbd7cf3 45
615238be 46class _ComponentClassConst(object._SharedObject):
81447b5b
PP
47 @property
48 def name(self):
85906b6b 49 ptr = self._bt_as_component_class_ptr(self._ptr)
601c0026
SM
50 name = native_bt.component_class_get_name(ptr)
51 assert name is not None
811644b8 52 return name
81447b5b
PP
53
54 @property
55 def description(self):
85906b6b 56 ptr = self._bt_as_component_class_ptr(self._ptr)
601c0026 57 return native_bt.component_class_get_description(ptr)
81447b5b 58
40910fbb
PP
59 @property
60 def help(self):
85906b6b 61 ptr = self._bt_as_component_class_ptr(self._ptr)
601c0026
SM
62 return native_bt.component_class_get_help(ptr)
63
85906b6b
FD
64 def _bt_component_class_ptr(self):
65 return self._bt_as_component_class_ptr(self._ptr)
40910fbb 66
811644b8 67 def __eq__(self, other):
615238be 68 if not isinstance(other, _ComponentClassConst):
811644b8
PP
69 try:
70 if not issubclass(other, _UserComponent):
71 return False
72 except TypeError:
73 return False
81447b5b 74
811644b8 75 return self.addr == other.addr
81447b5b
PP
76
77
615238be 78class _SourceComponentClassConst(_ComponentClassConst):
2f16a6a2
PP
79 _get_ref = staticmethod(native_bt.component_class_source_get_ref)
80 _put_ref = staticmethod(native_bt.component_class_source_put_ref)
cfbd7cf3
FD
81 _bt_as_component_class_ptr = staticmethod(
82 native_bt.component_class_source_as_component_class
83 )
81447b5b
PP
84
85
615238be 86class _FilterComponentClassConst(_ComponentClassConst):
2f16a6a2
PP
87 _get_ref = staticmethod(native_bt.component_class_filter_get_ref)
88 _put_ref = staticmethod(native_bt.component_class_filter_put_ref)
cfbd7cf3
FD
89 _bt_as_component_class_ptr = staticmethod(
90 native_bt.component_class_filter_as_component_class
91 )
81447b5b
PP
92
93
615238be 94class _SinkComponentClassConst(_ComponentClassConst):
2f16a6a2
PP
95 _get_ref = staticmethod(native_bt.component_class_sink_get_ref)
96 _put_ref = staticmethod(native_bt.component_class_sink_put_ref)
cfbd7cf3
FD
97 _bt_as_component_class_ptr = staticmethod(
98 native_bt.component_class_sink_as_component_class
99 )
81447b5b
PP
100
101
811644b8
PP
102class _PortIterator(collections.abc.Iterator):
103 def __init__(self, comp_ports):
104 self._comp_ports = comp_ports
105 self._at = 0
106
107 def __next__(self):
108 if self._at == len(self._comp_ports):
109 raise StopIteration
110
111 comp_ports = self._comp_ports
894a8df5
SM
112 comp_ptr = comp_ports._component_ptr
113
114 port_ptr = comp_ports._borrow_port_ptr_at_index(comp_ptr, self._at)
115 assert port_ptr is not None
116
117 name = native_bt.port_get_name(comp_ports._port_pycls._as_port_ptr(port_ptr))
118 assert name is not None
811644b8 119
811644b8
PP
120 self._at += 1
121 return name
122
123
124class _ComponentPorts(collections.abc.Mapping):
894a8df5
SM
125
126 # component_ptr is a bt_component_source *, bt_component_filter * or
127 # bt_component_sink *. Its type must match the type expected by the
128 # functions passed as arguments.
129
cfbd7cf3
FD
130 def __init__(
131 self,
132 component_ptr,
133 borrow_port_ptr_by_name,
134 borrow_port_ptr_at_index,
135 get_port_count,
136 port_pycls,
137 ):
894a8df5
SM
138 self._component_ptr = component_ptr
139 self._borrow_port_ptr_by_name = borrow_port_ptr_by_name
140 self._borrow_port_ptr_at_index = borrow_port_ptr_at_index
141 self._get_port_count = get_port_count
142 self._port_pycls = port_pycls
811644b8
PP
143
144 def __getitem__(self, key):
145 utils._check_str(key)
894a8df5 146 port_ptr = self._borrow_port_ptr_by_name(self._component_ptr, key)
811644b8
PP
147
148 if port_ptr is None:
149 raise KeyError(key)
150
894a8df5 151 return self._port_pycls._create_from_ptr_and_get_ref(port_ptr)
811644b8
PP
152
153 def __len__(self):
894a8df5
SM
154 count = self._get_port_count(self._component_ptr)
155 assert count >= 0
811644b8
PP
156 return count
157
158 def __iter__(self):
159 return _PortIterator(self)
160
161
81447b5b 162# This class holds the methods which are common to both generic
601c0026
SM
163# component objects and Python user component objects.
164#
165# Subclasses must provide these methods or property:
166#
85906b6b 167# - _bt_borrow_component_class_ptr: static method, must return a pointer to the
601c0026
SM
168# specialized component class (e.g. 'bt_component_class_sink *') of the
169# passed specialized component pointer (e.g. 'bt_component_sink *').
85906b6b 170# - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
601c0026 171# constants.
85906b6b 172# - _bt_as_component_ptr: static method, must return the passed specialized
1c9ed2ff 173# component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'.
601c0026 174
cfbd7cf3 175
615238be 176class _ComponentConst:
81447b5b
PP
177 @property
178 def name(self):
85906b6b 179 ptr = self._bt_as_component_ptr(self._ptr)
1c9ed2ff
SM
180 name = native_bt.component_get_name(ptr)
181 assert name is not None
811644b8
PP
182 return name
183
e874da19
PP
184 @property
185 def logging_level(self):
85906b6b 186 ptr = self._bt_as_component_ptr(self._ptr)
e874da19
PP
187 return native_bt.component_get_logging_level(ptr)
188
81447b5b 189 @property
e8ac1aae 190 def cls(self):
85906b6b 191 cc_ptr = self._bt_borrow_component_class_ptr(self._ptr)
601c0026 192 assert cc_ptr is not None
615238be 193 return _create_component_class_from_const_ptr_and_get_ref(
cfbd7cf3
FD
194 cc_ptr, self._bt_comp_cls_type
195 )
81447b5b 196
811644b8
PP
197 def __eq__(self, other):
198 if not hasattr(other, 'addr'):
199 return False
81447b5b 200
811644b8 201 return self.addr == other.addr
81447b5b 202
81447b5b 203
615238be 204class _SourceComponentConst(_ComponentConst):
cfbd7cf3
FD
205 _bt_borrow_component_class_ptr = staticmethod(
206 native_bt.component_source_borrow_class_const
207 )
85906b6b 208 _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
cfbd7cf3
FD
209 _bt_as_component_class_ptr = staticmethod(
210 native_bt.component_class_source_as_component_class
211 )
85906b6b 212 _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const)
81447b5b 213
81447b5b 214
615238be 215class _FilterComponentConst(_ComponentConst):
cfbd7cf3
FD
216 _bt_borrow_component_class_ptr = staticmethod(
217 native_bt.component_filter_borrow_class_const
218 )
85906b6b 219 _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
cfbd7cf3
FD
220 _bt_as_component_class_ptr = staticmethod(
221 native_bt.component_class_filter_as_component_class
222 )
85906b6b 223 _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const)
81447b5b 224
81447b5b 225
615238be 226class _SinkComponentConst(_ComponentConst):
cfbd7cf3
FD
227 _bt_borrow_component_class_ptr = staticmethod(
228 native_bt.component_sink_borrow_class_const
229 )
85906b6b 230 _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK
cfbd7cf3
FD
231 _bt_as_component_class_ptr = staticmethod(
232 native_bt.component_class_sink_as_component_class
233 )
85906b6b 234 _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const)
81447b5b
PP
235
236
615238be 237# This is analogous to _SourceComponentClassConst, but for source
81447b5b 238# component objects.
615238be 239class _GenericSourceComponentConst(object._SharedObject, _SourceComponentConst):
894a8df5
SM
240 _get_ref = staticmethod(native_bt.component_source_get_ref)
241 _put_ref = staticmethod(native_bt.component_source_put_ref)
242
811644b8
PP
243 @property
244 def output_ports(self):
cfbd7cf3
FD
245 return _ComponentPorts(
246 self._ptr,
247 native_bt.component_source_borrow_output_port_by_name_const,
248 native_bt.component_source_borrow_output_port_by_index_const,
249 native_bt.component_source_get_output_port_count,
5813b3a3 250 bt2_port._OutputPortConst,
cfbd7cf3 251 )
81447b5b
PP
252
253
615238be 254# This is analogous to _FilterComponentClassConst, but for filter
81447b5b 255# component objects.
615238be 256class _GenericFilterComponentConst(object._SharedObject, _FilterComponentConst):
894a8df5
SM
257 _get_ref = staticmethod(native_bt.component_filter_get_ref)
258 _put_ref = staticmethod(native_bt.component_filter_put_ref)
259
811644b8
PP
260 @property
261 def output_ports(self):
cfbd7cf3
FD
262 return _ComponentPorts(
263 self._ptr,
264 native_bt.component_filter_borrow_output_port_by_name_const,
265 native_bt.component_filter_borrow_output_port_by_index_const,
266 native_bt.component_filter_get_output_port_count,
5813b3a3 267 bt2_port._OutputPortConst,
cfbd7cf3 268 )
811644b8
PP
269
270 @property
271 def input_ports(self):
cfbd7cf3
FD
272 return _ComponentPorts(
273 self._ptr,
274 native_bt.component_filter_borrow_input_port_by_name_const,
275 native_bt.component_filter_borrow_input_port_by_index_const,
276 native_bt.component_filter_get_input_port_count,
5813b3a3 277 bt2_port._InputPortConst,
cfbd7cf3 278 )
81447b5b
PP
279
280
615238be 281# This is analogous to _SinkComponentClassConst, but for sink
81447b5b 282# component objects.
615238be 283class _GenericSinkComponentConst(object._SharedObject, _SinkComponentConst):
2f16a6a2
PP
284 _get_ref = staticmethod(native_bt.component_sink_get_ref)
285 _put_ref = staticmethod(native_bt.component_sink_put_ref)
601c0026 286
811644b8
PP
287 @property
288 def input_ports(self):
cfbd7cf3
FD
289 return _ComponentPorts(
290 self._ptr,
291 native_bt.component_sink_borrow_input_port_by_name_const,
292 native_bt.component_sink_borrow_input_port_by_index_const,
293 native_bt.component_sink_get_input_port_count,
5813b3a3 294 bt2_port._InputPortConst,
cfbd7cf3 295 )
81447b5b
PP
296
297
811644b8 298_COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = {
615238be
FD
299 native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentConst,
300 native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentConst,
301 native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentConst,
81447b5b
PP
302}
303
304
811644b8 305_COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = {
615238be
FD
306 native_bt.COMPONENT_CLASS_TYPE_SOURCE: _SourceComponentClassConst,
307 native_bt.COMPONENT_CLASS_TYPE_FILTER: _FilterComponentClassConst,
308 native_bt.COMPONENT_CLASS_TYPE_SINK: _SinkComponentClassConst,
81447b5b
PP
309}
310
311
615238be
FD
312# Create a component Python object of type _GenericSourceComponentConst,
313# _GenericFilterComponentConst or _GenericSinkComponentConst, depending on
601c0026
SM
314# comp_cls_type.
315#
316# Steals the reference to ptr from the caller.
317
cfbd7cf3 318
615238be 319def _create_component_from_const_ptr(ptr, comp_cls_type):
811644b8 320 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr)
81447b5b 321
5f25509b
SM
322
323# Same as the above, but acquire a new reference instead of stealing the
324# reference from the caller.
325
cfbd7cf3 326
615238be 327def _create_component_from_const_ptr_and_get_ref(ptr, comp_cls_type):
cfbd7cf3
FD
328 return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[
329 comp_cls_type
330 ]._create_from_ptr_and_get_ref(ptr)
5f25509b
SM
331
332
601c0026 333# Create a component class Python object of type
615238be
FD
334# _SourceComponentClassConst, _FilterComponentClassConst or
335# _SinkComponentClassConst, depending on comp_cls_type.
601c0026
SM
336#
337# Acquires a new reference to ptr.
81447b5b 338
cfbd7cf3 339
615238be 340def _create_component_class_from_const_ptr_and_get_ref(ptr, comp_cls_type):
cfbd7cf3
FD
341 return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[
342 comp_cls_type
343 ]._create_from_ptr_and_get_ref(ptr)
81447b5b
PP
344
345
40910fbb
PP
346def _trim_docstring(docstring):
347 lines = docstring.expandtabs().splitlines()
348 indent = sys.maxsize
349
350 for line in lines[1:]:
351 stripped = line.lstrip()
352
353 if stripped:
354 indent = min(indent, len(line) - len(stripped))
355
356 trimmed = [lines[0].strip()]
357
358 if indent < sys.maxsize:
359 for line in lines[1:]:
360 trimmed.append(line[indent:].rstrip())
361
362 while trimmed and not trimmed[-1]:
363 trimmed.pop()
364
365 while trimmed and not trimmed[0]:
366 trimmed.pop(0)
367
368 return '\n'.join(trimmed)
369
370
81447b5b
PP
371# Metaclass for component classes defined by Python code.
372#
373# The Python user can create a standard Python class which inherits one
811644b8
PP
374# of the three base classes (_UserSourceComponent, _UserFilterComponent,
375# or _UserSinkComponent). Those base classes set this class
81447b5b
PP
376# (_UserComponentType) as their metaclass.
377#
378# Once the body of a user-defined component class is executed, this
379# metaclass is used to create and initialize the class. The metaclass
380# creates a native BT component class of the corresponding type and
381# associates it with this user-defined class. The metaclass also defines
382# class methods like the `name` and `description` properties to match
615238be 383# the _ComponentClassConst interface.
81447b5b
PP
384#
385# The component class name which is used is either:
386#
387# * The `name` parameter of the class:
388#
389# class MySink(bt2.SinkComponent, name='my-custom-sink'):
390# ...
391#
392# * If the `name` class parameter is not used: the name of the class
393# itself (`MySink` in the example above).
394#
395# The component class description which is used is the user-defined
396# class's docstring:
397#
398# class MySink(bt2.SinkComponent):
399# 'Description goes here'
400# ...
401#
402# A user-defined Python component class can have an __init__() method
403# which must at least accept the `params` and `name` arguments:
404#
405# def __init__(self, params, name, something_else):
406# ...
407#
811644b8 408# The user-defined component class can also have a _finalize() method
81447b5b 409# (do NOT use __del__()) to be notified when the component object is
811644b8 410# finalized.
81447b5b
PP
411#
412# User-defined source and filter component classes must use the
5602ef81
SM
413# `message_iterator_class` class parameter to specify the
414# message iterator class to use for this component class:
81447b5b 415#
5602ef81 416# class MyMessageIterator(bt2._UserMessageIterator):
81447b5b
PP
417# ...
418#
811644b8 419# class MySource(bt2._UserSourceComponent,
5602ef81 420# message_iterator_class=MyMessageIterator):
81447b5b
PP
421# ...
422#
5602ef81
SM
423# This message iterator class must inherit
424# bt2._UserMessageIterator, and it must define the _get() and
425# _next() methods. The message iterator class can also define an
81447b5b
PP
426# __init__() method: this method has access to the original Python
427# component object which was used to create it as the `component`
5602ef81 428# property. The message iterator class can also define a
811644b8 429# _finalize() method (again, do NOT use __del__()): this is called when
5602ef81 430# the message iterator is (really) destroyed.
81447b5b
PP
431#
432# When the user-defined class is destroyed, this metaclass's __del__()
433# method is called: the native BT component class pointer is put (not
434# needed anymore, at least not by any Python code since all references
435# are dropped for __del__() to be called).
436class _UserComponentType(type):
437 # __new__() is used to catch custom class parameters
438 def __new__(meta_cls, class_name, bases, attrs, **kwargs):
439 return super().__new__(meta_cls, class_name, bases, attrs)
440
441 def __init__(cls, class_name, bases, namespace, **kwargs):
442 super().__init__(class_name, bases, namespace)
443
444 # skip our own bases; they are never directly instantiated by the user
811644b8
PP
445 own_bases = (
446 '_UserComponent',
447 '_UserFilterSinkComponent',
448 '_UserSourceComponent',
449 '_UserFilterComponent',
450 '_UserSinkComponent',
451 )
452
453 if class_name in own_bases:
81447b5b
PP
454 return
455
456 comp_cls_name = kwargs.get('name', class_name)
811644b8 457 utils._check_str(comp_cls_name)
40910fbb
PP
458 comp_cls_descr = None
459 comp_cls_help = None
460
461 if hasattr(cls, '__doc__') and cls.__doc__ is not None:
811644b8 462 utils._check_str(cls.__doc__)
40910fbb
PP
463 docstring = _trim_docstring(cls.__doc__)
464 lines = docstring.splitlines()
465
466 if len(lines) >= 1:
467 comp_cls_descr = lines[0]
468
469 if len(lines) >= 3:
470 comp_cls_help = '\n'.join(lines[2:])
471
5602ef81 472 iter_cls = kwargs.get('message_iterator_class')
81447b5b 473
811644b8 474 if _UserSourceComponent in bases:
85906b6b 475 _UserComponentType._bt_set_iterator_class(cls, iter_cls)
cfbd7cf3
FD
476 cc_ptr = native_bt.bt2_component_class_source_create(
477 cls, comp_cls_name, comp_cls_descr, comp_cls_help
478 )
811644b8 479 elif _UserFilterComponent in bases:
85906b6b 480 _UserComponentType._bt_set_iterator_class(cls, iter_cls)
cfbd7cf3
FD
481 cc_ptr = native_bt.bt2_component_class_filter_create(
482 cls, comp_cls_name, comp_cls_descr, comp_cls_help
483 )
811644b8 484 elif _UserSinkComponent in bases:
6a91742b 485 if not hasattr(cls, '_user_consume'):
cb06aa27 486 raise bt2._IncompleteUserClass(
6a91742b 487 "cannot create component class '{}': missing a _user_consume() method".format(
cfbd7cf3
FD
488 class_name
489 )
490 )
491
492 cc_ptr = native_bt.bt2_component_class_sink_create(
493 cls, comp_cls_name, comp_cls_descr, comp_cls_help
494 )
81447b5b 495 else:
cb06aa27 496 raise bt2._IncompleteUserClass(
cfbd7cf3
FD
497 "cannot find a known component class base in the bases of '{}'".format(
498 class_name
499 )
500 )
81447b5b
PP
501
502 if cc_ptr is None:
694c792b 503 raise bt2._MemoryError(
cfbd7cf3
FD
504 "cannot create component class '{}'".format(class_name)
505 )
81447b5b 506
85906b6b 507 cls._bt_cc_ptr = cc_ptr
81447b5b 508
66964f3f 509 def _bt_init_from_native(cls, comp_ptr, params_ptr, obj):
811644b8 510 # create instance, not user-initialized yet
81447b5b
PP
511 self = cls.__new__(cls)
512
59225a3e
SM
513 # config object
514 config = cls._config_pycls()
515
601c0026 516 # pointer to native self component object (weak/borrowed)
85906b6b 517 self._bt_ptr = comp_ptr
81447b5b 518
811644b8
PP
519 # call user's __init__() method
520 if params_ptr is not None:
e42e1587 521 params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr)
811644b8
PP
522 else:
523 params = None
81447b5b 524
59225a3e 525 self.__init__(config, params, obj)
81447b5b
PP
526 return self
527
811644b8 528 def __call__(cls, *args, **kwargs):
ce4923b0 529 raise RuntimeError(
cfbd7cf3
FD
530 'cannot directly instantiate a user component from a Python module'
531 )
81447b5b
PP
532
533 @staticmethod
85906b6b 534 def _bt_set_iterator_class(cls, iter_cls):
81447b5b 535 if iter_cls is None:
cb06aa27 536 raise bt2._IncompleteUserClass(
cfbd7cf3
FD
537 "cannot create component class '{}': missing message iterator class".format(
538 cls.__name__
539 )
540 )
81447b5b 541
3fb99a22 542 if not issubclass(iter_cls, bt2_message_iterator._UserMessageIterator):
cb06aa27 543 raise bt2._IncompleteUserClass(
cfbd7cf3
FD
544 "cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(
545 cls.__name__
546 )
547 )
81447b5b 548
811644b8 549 if not hasattr(iter_cls, '__next__'):
cb06aa27 550 raise bt2._IncompleteUserClass(
cfbd7cf3
FD
551 "cannot create component class '{}': message iterator class is missing a __next__() method".format(
552 cls.__name__
553 )
554 )
81447b5b
PP
555
556 cls._iter_cls = iter_cls
557
558 @property
559 def name(cls):
85906b6b 560 ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
601c0026 561 return native_bt.component_class_get_name(ptr)
81447b5b
PP
562
563 @property
564 def description(cls):
85906b6b 565 ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
601c0026 566 return native_bt.component_class_get_description(ptr)
81447b5b 567
40910fbb
PP
568 @property
569 def help(cls):
85906b6b 570 ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
601c0026 571 return native_bt.component_class_get_help(ptr)
40910fbb 572
81447b5b
PP
573 @property
574 def addr(cls):
85906b6b 575 return int(cls._bt_cc_ptr)
81447b5b 576
fd57054b
PP
577 def _bt_get_supported_mip_versions_from_native(cls, params_ptr, obj, log_level):
578 # this can raise, but the native side checks the exception
579 if params_ptr is not None:
e42e1587 580 params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr)
fd57054b
PP
581 else:
582 params = None
583
584 # this can raise, but the native side checks the exception
585 range_set = cls._user_get_supported_mip_versions(params, obj, log_level)
586
587 if type(range_set) is not bt2.UnsignedIntegerRangeSet:
588 # this can raise, but the native side checks the exception
589 range_set = bt2.UnsignedIntegerRangeSet(range_set)
590
591 # return new reference
592 range_set._get_ref(range_set._ptr)
593 return int(range_set._ptr)
594
595 def _user_get_supported_mip_versions(cls, params, obj, log_level):
596 return [0]
597
7c14d641 598 def _bt_query_from_native(cls, priv_query_exec_ptr, object, params_ptr, method_obj):
fd57054b 599 # this can raise, but the native side checks the exception
811644b8 600 if params_ptr is not None:
e42e1587 601 params = bt2_value._create_from_const_ptr_and_get_ref(params_ptr)
811644b8
PP
602 else:
603 params = None
604
3c729b9a 605 priv_query_exec = bt2_query_executor._PrivateQueryExecutor(priv_query_exec_ptr)
811644b8 606
3c729b9a
PP
607 try:
608 # this can raise, but the native side checks the exception
7c14d641 609 results = cls._user_query(priv_query_exec, object, params, method_obj)
3c729b9a
PP
610 finally:
611 # the private query executor is a private view on the query
612 # executor; it's not a shared object (the library does not
613 # offer an API to get/put a reference, just like "self"
614 # objects) from this query's point of view, so invalidate
615 # the object in case the user kept a reference and uses it
616 # later
617 priv_query_exec._invalidate()
811644b8 618
c7eee084
PP
619 # this can raise, but the native side checks the exception
620 results = bt2.create_value(results)
911dec08
PP
621
622 if results is None:
b5947615 623 results_ptr = native_bt.value_null
911dec08 624 else:
b5947615 625 results_ptr = results._ptr
911dec08 626
3c729b9a 627 # return new reference
3fb99a22 628 bt2_value._Value._get_ref(results_ptr)
b5947615 629 return int(results_ptr)
911dec08 630
7c14d641 631 def _user_query(cls, priv_query_executor, object, params, method_obj):
76b6c2f7 632 raise bt2.UnknownObject
811644b8 633
85906b6b
FD
634 def _bt_component_class_ptr(self):
635 return self._bt_as_component_class_ptr(self._bt_cc_ptr)
911dec08 636
81447b5b 637 def __del__(cls):
85906b6b
FD
638 if hasattr(cls, '_bt_cc_ptr'):
639 cc_ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
601c0026 640 native_bt.component_class_put_ref(cc_ptr)
ab1cea3f 641 native_bt.bt2_unregister_cc_ptr_to_py_cls(cc_ptr)
81447b5b 642
cfbd7cf3 643
59225a3e
SM
644# Configuration objects for components.
645#
646# These are passed in __init__ to allow components to change some configuration
647# parameters during initialization and not after. As you can see, they are not
648# used at the moment, but are there in case we want to add such parameters.
649
650
651class _UserComponentConfiguration:
652 pass
653
654
655class _UserSourceComponentConfiguration(_UserComponentConfiguration):
656 pass
657
658
659class _UserFilterComponentConfiguration(_UserComponentConfiguration):
660 pass
661
662
663class _UserSinkComponentConfiguration(_UserComponentConfiguration):
664 pass
665
666
1c9ed2ff
SM
667# Subclasses must provide these methods or property:
668#
85906b6b 669# - _bt_as_not_self_specific_component_ptr: static method, must return the passed
1c9ed2ff
SM
670# specialized self component pointer (e.g. 'bt_self_component_sink *') as a
671# specialized non-self pointer (e.g. 'bt_component_sink *').
85906b6b 672# - _bt_borrow_component_class_ptr: static method, must return a pointer to the
1c9ed2ff
SM
673# specialized component class (e.g. 'bt_component_class_sink *') of the
674# passed specialized component pointer (e.g. 'bt_component_sink *').
85906b6b 675# - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
1c9ed2ff 676# constants.
81447b5b 677
cfbd7cf3 678
811644b8
PP
679class _UserComponent(metaclass=_UserComponentType):
680 @property
681 def name(self):
85906b6b
FD
682 ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
683 ptr = self._bt_as_component_ptr(ptr)
1c9ed2ff
SM
684 name = native_bt.component_get_name(ptr)
685 assert name is not None
811644b8 686 return name
81447b5b 687
e874da19
PP
688 @property
689 def logging_level(self):
85906b6b
FD
690 ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
691 ptr = self._bt_as_component_ptr(ptr)
e874da19
PP
692 return native_bt.component_get_logging_level(ptr)
693
811644b8 694 @property
e8ac1aae 695 def cls(self):
85906b6b
FD
696 comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
697 cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr)
615238be 698 return _create_component_class_from_const_ptr_and_get_ref(
cfbd7cf3
FD
699 cc_ptr, self._bt_comp_cls_type
700 )
81447b5b 701
81447b5b
PP
702 @property
703 def addr(self):
85906b6b 704 return int(self._bt_ptr)
81447b5b 705
056deb59
PP
706 @property
707 def _graph_mip_version(self):
708 ptr = self._bt_as_self_component_ptr(self._bt_ptr)
709 return native_bt.self_component_get_graph_mip_version(ptr)
710
59225a3e 711 def __init__(self, config, params, obj):
81447b5b
PP
712 pass
713
6a91742b 714 def _user_finalize(self):
81447b5b
PP
715 pass
716
6a91742b 717 def _user_port_connected(self, port, other_port):
811644b8 718 pass
81447b5b 719
cfbd7cf3
FD
720 def _bt_port_connected_from_native(
721 self, self_port_ptr, self_port_type, other_port_ptr
722 ):
3fb99a22 723 port = bt2_port._create_self_from_ptr_and_get_ref(self_port_ptr, self_port_type)
2c67587a
SM
724
725 if self_port_type == native_bt.PORT_TYPE_OUTPUT:
726 other_port_type = native_bt.PORT_TYPE_INPUT
727 else:
728 other_port_type = native_bt.PORT_TYPE_OUTPUT
729
5813b3a3 730 other_port = bt2_port._create_from_const_ptr_and_get_ref(
cfbd7cf3
FD
731 other_port_ptr, other_port_type
732 )
6a91742b 733 self._user_port_connected(port, other_port)
81447b5b 734
5783664e
PP
735 def _create_trace_class(
736 self, user_attributes=None, assigns_automatic_stream_class_id=True
737 ):
85906b6b 738 ptr = self._bt_as_self_component_ptr(self._bt_ptr)
fbbe9302
SM
739 tc_ptr = native_bt.trace_class_create(ptr)
740
741 if tc_ptr is None:
694c792b 742 raise bt2._MemoryError('could not create trace class')
fbbe9302 743
3fb99a22 744 tc = bt2_trace_class._TraceClass._create_from_ptr(tc_ptr)
fbbe9302
SM
745 tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id
746
5783664e
PP
747 if user_attributes is not None:
748 tc._user_attributes = user_attributes
749
fbbe9302
SM
750 return tc
751
cfbd7cf3
FD
752 def _create_clock_class(
753 self,
754 frequency=None,
755 name=None,
5783664e 756 user_attributes=None,
cfbd7cf3
FD
757 description=None,
758 precision=None,
759 offset=None,
760 origin_is_unix_epoch=True,
761 uuid=None,
762 ):
85906b6b 763 ptr = self._bt_as_self_component_ptr(self._bt_ptr)
3cdfbaea
SM
764 cc_ptr = native_bt.clock_class_create(ptr)
765
766 if cc_ptr is None:
694c792b 767 raise bt2._MemoryError('could not create clock class')
3cdfbaea 768
3fb99a22 769 cc = bt2_clock_class._ClockClass._create_from_ptr(cc_ptr)
2ae9f48c
SM
770
771 if frequency is not None:
772 cc._frequency = frequency
773
be7bbff9
SM
774 if name is not None:
775 cc._name = name
776
5783664e
PP
777 if user_attributes is not None:
778 cc._user_attributes = user_attributes
779
be7bbff9
SM
780 if description is not None:
781 cc._description = description
782
783 if precision is not None:
784 cc._precision = precision
785
786 if offset is not None:
787 cc._offset = offset
788
789 cc._origin_is_unix_epoch = origin_is_unix_epoch
790
791 if uuid is not None:
792 cc._uuid = uuid
793
2ae9f48c 794 return cc
3cdfbaea 795
81447b5b 796
615238be 797class _UserSourceComponent(_UserComponent, _SourceComponentConst):
cfbd7cf3
FD
798 _bt_as_not_self_specific_component_ptr = staticmethod(
799 native_bt.self_component_source_as_component_source
800 )
801 _bt_as_self_component_ptr = staticmethod(
802 native_bt.self_component_source_as_self_component
803 )
59225a3e 804 _config_pycls = _UserSourceComponentConfiguration
1c9ed2ff 805
81447b5b 806 @property
811644b8 807 def _output_ports(self):
894a8df5 808 def get_output_port_count(self_ptr):
85906b6b 809 ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
894a8df5
SM
810 return native_bt.component_source_get_output_port_count(ptr)
811
cfbd7cf3
FD
812 return _ComponentPorts(
813 self._bt_ptr,
814 native_bt.self_component_source_borrow_output_port_by_name,
815 native_bt.self_component_source_borrow_output_port_by_index,
816 get_output_port_count,
3fb99a22 817 bt2_port._UserComponentOutputPort,
cfbd7cf3 818 )
811644b8 819
2e00bc76 820 def _add_output_port(self, name, user_data=None):
811644b8 821 utils._check_str(name)
894a8df5 822 fn = native_bt.self_component_source_add_output_port
85906b6b 823 comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
cfbd7cf3
FD
824 utils._handle_func_status(
825 comp_status, 'cannot add output port to source component object'
826 )
894a8df5 827 assert self_port_ptr is not None
3fb99a22 828 return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
811644b8
PP
829
830
615238be 831class _UserFilterComponent(_UserComponent, _FilterComponentConst):
cfbd7cf3
FD
832 _bt_as_not_self_specific_component_ptr = staticmethod(
833 native_bt.self_component_filter_as_component_filter
834 )
835 _bt_as_self_component_ptr = staticmethod(
836 native_bt.self_component_filter_as_self_component
837 )
59225a3e 838 _config_pycls = _UserFilterComponentConfiguration
1c9ed2ff 839
811644b8
PP
840 @property
841 def _output_ports(self):
894a8df5 842 def get_output_port_count(self_ptr):
85906b6b 843 ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
894a8df5
SM
844 return native_bt.component_filter_get_output_port_count(ptr)
845
cfbd7cf3
FD
846 return _ComponentPorts(
847 self._bt_ptr,
848 native_bt.self_component_filter_borrow_output_port_by_name,
849 native_bt.self_component_filter_borrow_output_port_by_index,
850 get_output_port_count,
3fb99a22 851 bt2_port._UserComponentOutputPort,
cfbd7cf3 852 )
81447b5b 853
811644b8
PP
854 @property
855 def _input_ports(self):
894a8df5 856 def get_input_port_count(self_ptr):
85906b6b 857 ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
894a8df5
SM
858 return native_bt.component_filter_get_input_port_count(ptr)
859
cfbd7cf3
FD
860 return _ComponentPorts(
861 self._bt_ptr,
862 native_bt.self_component_filter_borrow_input_port_by_name,
863 native_bt.self_component_filter_borrow_input_port_by_index,
864 get_input_port_count,
3fb99a22 865 bt2_port._UserComponentInputPort,
cfbd7cf3 866 )
811644b8 867
2e00bc76 868 def _add_output_port(self, name, user_data=None):
811644b8 869 utils._check_str(name)
894a8df5 870 fn = native_bt.self_component_filter_add_output_port
85906b6b 871 comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
cfbd7cf3
FD
872 utils._handle_func_status(
873 comp_status, 'cannot add output port to filter component object'
874 )
894a8df5 875 assert self_port_ptr
3fb99a22 876 return bt2_port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
811644b8 877
2e00bc76 878 def _add_input_port(self, name, user_data=None):
811644b8 879 utils._check_str(name)
894a8df5 880 fn = native_bt.self_component_filter_add_input_port
85906b6b 881 comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
cfbd7cf3
FD
882 utils._handle_func_status(
883 comp_status, 'cannot add input port to filter component object'
884 )
894a8df5 885 assert self_port_ptr
3fb99a22 886 return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr)
811644b8
PP
887
888
615238be 889class _UserSinkComponent(_UserComponent, _SinkComponentConst):
cfbd7cf3
FD
890 _bt_as_not_self_specific_component_ptr = staticmethod(
891 native_bt.self_component_sink_as_component_sink
892 )
893 _bt_as_self_component_ptr = staticmethod(
894 native_bt.self_component_sink_as_self_component
895 )
59225a3e 896 _config_pycls = _UserSinkComponentConfiguration
1c9ed2ff 897
d14a864a 898 def _bt_graph_is_configured_from_native(self):
6a91742b 899 self._user_graph_is_configured()
d14a864a 900
6a91742b 901 def _user_graph_is_configured(self):
cd1ef6f2
PP
902 pass
903
811644b8
PP
904 @property
905 def _input_ports(self):
894a8df5 906 def get_input_port_count(self_ptr):
85906b6b 907 ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
894a8df5
SM
908 return native_bt.component_sink_get_input_port_count(ptr)
909
cfbd7cf3
FD
910 return _ComponentPorts(
911 self._bt_ptr,
912 native_bt.self_component_sink_borrow_input_port_by_name,
913 native_bt.self_component_sink_borrow_input_port_by_index,
914 get_input_port_count,
3fb99a22 915 bt2_port._UserComponentInputPort,
cfbd7cf3 916 )
811644b8 917
2e00bc76 918 def _add_input_port(self, name, user_data=None):
811644b8 919 utils._check_str(name)
894a8df5 920 fn = native_bt.self_component_sink_add_input_port
85906b6b 921 comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
cfbd7cf3
FD
922 utils._handle_func_status(
923 comp_status, 'cannot add input port to sink component object'
924 )
5f25509b 925 assert self_port_ptr
3fb99a22 926 return bt2_port._UserComponentInputPort._create_from_ptr(self_port_ptr)
ca02df0a
PP
927
928 def _create_input_port_message_iterator(self, input_port):
3fb99a22 929 utils._check_type(input_port, bt2_port._UserComponentInputPort)
ca02df0a 930
e803df70 931 status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_sink_component(
ca02df0a
PP
932 self._bt_ptr, input_port._ptr
933 )
e803df70
SM
934 utils._handle_func_status(status, 'cannot create message iterator object')
935 assert msg_iter_ptr is not None
ca02df0a 936
3fb99a22 937 return bt2_message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr)
9b4f9b42
PP
938
939 @property
940 def _is_interrupted(self):
941 return bool(native_bt.self_component_sink_is_interrupted(self._bt_ptr))
This page took 0.099747 seconds and 4 git commands to generate.