src/bindings/python/bt2/bt2/component.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object, utils
  24 import bt2.message_iterator
  25 import collections.abc
  26 import bt2.value
  27 import traceback
  28 import bt2.port
  29 import sys
  30 import bt2
  31 import os
  32
  33
  34 # This class wraps a component class pointer. This component class could
  35 # have been created by Python code, but since we only have the pointer,
  36 # we can only wrap it in a generic way and lose the original Python
  37 # class.
  38 #
  39 # Subclasses must implement some methods that this base class uses:
  40 #
  41 #   - _bt_as_component_class_ptr: static method, convert the passed component class
  42 #     pointer to a 'bt_component_class *'.
  43
  44 class _GenericComponentClass(object._SharedObject):
  45     @property
  46     def name(self):
  47         ptr = self._bt_as_component_class_ptr(self._ptr)
  48         name = native_bt.component_class_get_name(ptr)
  49         assert name is not None
  50         return name
  51
  52     @property
  53     def description(self):
  54         ptr = self._bt_as_component_class_ptr(self._ptr)
  55         return native_bt.component_class_get_description(ptr)
  56
  57     @property
  58     def help(self):
  59         ptr = self._bt_as_component_class_ptr(self._ptr)
  60         return native_bt.component_class_get_help(ptr)
  61
  62     def _bt_component_class_ptr(self):
  63         return self._bt_as_component_class_ptr(self._ptr)
  64
  65     def __eq__(self, other):
  66         if not isinstance(other, _GenericComponentClass):
  67             try:
  68                 if not issubclass(other, _UserComponent):
  69                     return False
  70             except TypeError:
  71                 return False
  72
  73         return self.addr == other.addr
  74
  75
  76 class _GenericSourceComponentClass(_GenericComponentClass):
  77     _get_ref = staticmethod(native_bt.component_class_source_get_ref)
  78     _put_ref = staticmethod(native_bt.component_class_source_put_ref)
  79     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_source_as_component_class)
  80
  81
  82 class _GenericFilterComponentClass(_GenericComponentClass):
  83     _get_ref = staticmethod(native_bt.component_class_filter_get_ref)
  84     _put_ref = staticmethod(native_bt.component_class_filter_put_ref)
  85     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_filter_as_component_class)
  86
  87
  88 class _GenericSinkComponentClass(_GenericComponentClass):
  89     _get_ref = staticmethod(native_bt.component_class_sink_get_ref)
  90     _put_ref = staticmethod(native_bt.component_class_sink_put_ref)
  91     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_sink_as_component_class)
  92
  93
  94 class _PortIterator(collections.abc.Iterator):
  95     def __init__(self, comp_ports):
  96         self._comp_ports = comp_ports
  97         self._at = 0
  98
  99     def __next__(self):
 100         if self._at == len(self._comp_ports):
 101             raise StopIteration
 102
 103         comp_ports = self._comp_ports
 104         comp_ptr = comp_ports._component_ptr
 105
 106         port_ptr = comp_ports._borrow_port_ptr_at_index(comp_ptr, self._at)
 107         assert port_ptr is not None
 108
 109         name = native_bt.port_get_name(comp_ports._port_pycls._as_port_ptr(port_ptr))
 110         assert name is not None
 111
 112         self._at += 1
 113         return name
 114
 115
 116 class _ComponentPorts(collections.abc.Mapping):
 117
 118     # component_ptr is a bt_component_source *, bt_component_filter * or
 119     # bt_component_sink *.  Its type must match the type expected by the
 120     # functions passed as arguments.
 121
 122     def __init__(self, component_ptr,
 123                  borrow_port_ptr_by_name,
 124                  borrow_port_ptr_at_index,
 125                  get_port_count,
 126                  port_pycls):
 127         self._component_ptr = component_ptr
 128         self._borrow_port_ptr_by_name = borrow_port_ptr_by_name
 129         self._borrow_port_ptr_at_index = borrow_port_ptr_at_index
 130         self._get_port_count = get_port_count
 131         self._port_pycls = port_pycls
 132
 133     def __getitem__(self, key):
 134         utils._check_str(key)
 135         port_ptr = self._borrow_port_ptr_by_name(self._component_ptr, key)
 136
 137         if port_ptr is None:
 138             raise KeyError(key)
 139
 140         return self._port_pycls._create_from_ptr_and_get_ref(port_ptr)
 141
 142     def __len__(self):
 143         count = self._get_port_count(self._component_ptr)
 144         assert count >= 0
 145         return count
 146
 147     def __iter__(self):
 148         return _PortIterator(self)
 149
 150
 151 # This class holds the methods which are common to both generic
 152 # component objects and Python user component objects.
 153 #
 154 # Subclasses must provide these methods or property:
 155 #
 156 #   - _bt_borrow_component_class_ptr: static method, must return a pointer to the
 157 #     specialized component class (e.g. 'bt_component_class_sink *') of the
 158 #     passed specialized component pointer (e.g. 'bt_component_sink *').
 159 #   - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
 160 #     constants.
 161 #   - _bt_as_component_ptr: static method, must return the passed specialized
 162 #     component pointer (e.g. 'bt_component_sink *') as a 'bt_component *'.
 163
 164 class _Component:
 165     @property
 166     def name(self):
 167         ptr = self._bt_as_component_ptr(self._ptr)
 168         name = native_bt.component_get_name(ptr)
 169         assert name is not None
 170         return name
 171
 172     @property
 173     def logging_level(self):
 174         ptr = self._bt_as_component_ptr(self._ptr)
 175         return native_bt.component_get_logging_level(ptr)
 176
 177     @property
 178     def cls(self):
 179         cc_ptr = self._bt_borrow_component_class_ptr(self._ptr)
 180         assert cc_ptr is not None
 181         return _create_component_class_from_ptr_and_get_ref(cc_ptr, self._bt_comp_cls_type)
 182
 183     def __eq__(self, other):
 184         if not hasattr(other, 'addr'):
 185             return False
 186
 187         return self.addr == other.addr
 188
 189
 190 class _SourceComponent(_Component):
 191     _bt_borrow_component_class_ptr = staticmethod(native_bt.component_source_borrow_class_const)
 192     _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
 193     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_source_as_component_class)
 194     _bt_as_component_ptr = staticmethod(native_bt.component_source_as_component_const)
 195
 196
 197 class _FilterComponent(_Component):
 198     _bt_borrow_component_class_ptr = staticmethod(native_bt.component_filter_borrow_class_const)
 199     _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
 200     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_filter_as_component_class)
 201     _bt_as_component_ptr = staticmethod(native_bt.component_filter_as_component_const)
 202
 203
 204 class _SinkComponent(_Component):
 205     _bt_borrow_component_class_ptr = staticmethod(native_bt.component_sink_borrow_class_const)
 206     _bt_comp_cls_type = native_bt.COMPONENT_CLASS_TYPE_SINK
 207     _bt_as_component_class_ptr = staticmethod(native_bt.component_class_sink_as_component_class)
 208     _bt_as_component_ptr = staticmethod(native_bt.component_sink_as_component_const)
 209
 210
 211 # This is analogous to _GenericSourceComponentClass, but for source
 212 # component objects.
 213 class _GenericSourceComponent(object._SharedObject, _SourceComponent):
 214     _get_ref = staticmethod(native_bt.component_source_get_ref)
 215     _put_ref = staticmethod(native_bt.component_source_put_ref)
 216
 217     @property
 218     def output_ports(self):
 219         return _ComponentPorts(self._ptr,
 220                                native_bt.component_source_borrow_output_port_by_name_const,
 221                                native_bt.component_source_borrow_output_port_by_index_const,
 222                                native_bt.component_source_get_output_port_count,
 223                                bt2.port._OutputPort)
 224
 225
 226 # This is analogous to _GenericFilterComponentClass, but for filter
 227 # component objects.
 228 class _GenericFilterComponent(object._SharedObject, _FilterComponent):
 229     _get_ref = staticmethod(native_bt.component_filter_get_ref)
 230     _put_ref = staticmethod(native_bt.component_filter_put_ref)
 231
 232     @property
 233     def output_ports(self):
 234         return _ComponentPorts(self._ptr,
 235                                native_bt.component_filter_borrow_output_port_by_name_const,
 236                                native_bt.component_filter_borrow_output_port_by_index_const,
 237                                native_bt.component_filter_get_output_port_count,
 238                                bt2.port._OutputPort)
 239
 240     @property
 241     def input_ports(self):
 242         return _ComponentPorts(self._ptr,
 243                                native_bt.component_filter_borrow_input_port_by_name_const,
 244                                native_bt.component_filter_borrow_input_port_by_index_const,
 245                                native_bt.component_filter_get_input_port_count,
 246                                bt2.port._InputPort)
 247
 248
 249 # This is analogous to _GenericSinkComponentClass, but for sink
 250 # component objects.
 251 class _GenericSinkComponent(object._SharedObject, _SinkComponent):
 252     _get_ref = staticmethod(native_bt.component_sink_get_ref)
 253     _put_ref = staticmethod(native_bt.component_sink_put_ref)
 254
 255     @property
 256     def input_ports(self):
 257         return _ComponentPorts(self._ptr,
 258                                native_bt.component_sink_borrow_input_port_by_name_const,
 259                                native_bt.component_sink_borrow_input_port_by_index_const,
 260                                native_bt.component_sink_get_input_port_count,
 261                                bt2.port._InputPort)
 262
 263
 264 _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS = {
 265     native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponent,
 266     native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponent,
 267     native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponent,
 268 }
 269
 270
 271 _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS = {
 272     native_bt.COMPONENT_CLASS_TYPE_SOURCE: _GenericSourceComponentClass,
 273     native_bt.COMPONENT_CLASS_TYPE_FILTER: _GenericFilterComponentClass,
 274     native_bt.COMPONENT_CLASS_TYPE_SINK: _GenericSinkComponentClass,
 275 }
 276
 277
 278 # Create a component Python object of type _GenericSourceComponent,
 279 # _GenericFilterComponent or _GenericSinkComponent, depending on
 280 # comp_cls_type.
 281 #
 282 #    Steals the reference to ptr from the caller.
 283
 284 def _create_component_from_ptr(ptr, comp_cls_type):
 285     return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr(ptr)
 286
 287
 288 # Same as the above, but acquire a new reference instead of stealing the
 289 # reference from the caller.
 290
 291 def _create_component_from_ptr_and_get_ref(ptr, comp_cls_type):
 292     return _COMP_CLS_TYPE_TO_GENERIC_COMP_PYCLS[comp_cls_type]._create_from_ptr_and_get_ref(ptr)
 293
 294
 295 # Create a component class Python object of type
 296 # _GenericSourceComponentClass, _GenericFilterComponentClass or
 297 # _GenericSinkComponentClass, depending on comp_cls_type.
 298 #
 299 # Acquires a new reference to ptr.
 300
 301 def _create_component_class_from_ptr_and_get_ref(ptr, comp_cls_type):
 302     return _COMP_CLS_TYPE_TO_GENERIC_COMP_CLS_PYCLS[comp_cls_type]._create_from_ptr_and_get_ref(ptr)
 303
 304
 305 def _trim_docstring(docstring):
 306     lines = docstring.expandtabs().splitlines()
 307     indent = sys.maxsize
 308
 309     for line in lines[1:]:
 310         stripped = line.lstrip()
 311
 312         if stripped:
 313             indent = min(indent, len(line) - len(stripped))
 314
 315     trimmed = [lines[0].strip()]
 316
 317     if indent < sys.maxsize:
 318         for line in lines[1:]:
 319             trimmed.append(line[indent:].rstrip())
 320
 321     while trimmed and not trimmed[-1]:
 322         trimmed.pop()
 323
 324     while trimmed and not trimmed[0]:
 325         trimmed.pop(0)
 326
 327     return '\n'.join(trimmed)
 328
 329
 330 # Metaclass for component classes defined by Python code.
 331 #
 332 # The Python user can create a standard Python class which inherits one
 333 # of the three base classes (_UserSourceComponent, _UserFilterComponent,
 334 # or _UserSinkComponent). Those base classes set this class
 335 # (_UserComponentType) as their metaclass.
 336 #
 337 # Once the body of a user-defined component class is executed, this
 338 # metaclass is used to create and initialize the class. The metaclass
 339 # creates a native BT component class of the corresponding type and
 340 # associates it with this user-defined class. The metaclass also defines
 341 # class methods like the `name` and `description` properties to match
 342 # the _GenericComponentClass interface.
 343 #
 344 # The component class name which is used is either:
 345 #
 346 # * The `name` parameter of the class:
 347 #
 348 #       class MySink(bt2.SinkComponent, name='my-custom-sink'):
 349 #           ...
 350 #
 351 # * If the `name` class parameter is not used: the name of the class
 352 #   itself (`MySink` in the example above).
 353 #
 354 # The component class description which is used is the user-defined
 355 # class's docstring:
 356 #
 357 #     class MySink(bt2.SinkComponent):
 358 #         'Description goes here'
 359 #         ...
 360 #
 361 # A user-defined Python component class can have an __init__() method
 362 # which must at least accept the `params` and `name` arguments:
 363 #
 364 #     def __init__(self, params, name, something_else):
 365 #         ...
 366 #
 367 # The user-defined component class can also have a _finalize() method
 368 # (do NOT use __del__()) to be notified when the component object is
 369 # finalized.
 370 #
 371 # User-defined source and filter component classes must use the
 372 # `message_iterator_class` class parameter to specify the
 373 # message iterator class to use for this component class:
 374 #
 375 #     class MyMessageIterator(bt2._UserMessageIterator):
 376 #         ...
 377 #
 378 #     class MySource(bt2._UserSourceComponent,
 379 #                    message_iterator_class=MyMessageIterator):
 380 #         ...
 381 #
 382 # This message iterator class must inherit
 383 # bt2._UserMessageIterator, and it must define the _get() and
 384 # _next() methods. The message iterator class can also define an
 385 # __init__() method: this method has access to the original Python
 386 # component object which was used to create it as the `component`
 387 # property. The message iterator class can also define a
 388 # _finalize() method (again, do NOT use __del__()): this is called when
 389 # the message iterator is (really) destroyed.
 390 #
 391 # When the user-defined class is destroyed, this metaclass's __del__()
 392 # method is called: the native BT component class pointer is put (not
 393 # needed anymore, at least not by any Python code since all references
 394 # are dropped for __del__() to be called).
 395 class _UserComponentType(type):
 396     # __new__() is used to catch custom class parameters
 397     def __new__(meta_cls, class_name, bases, attrs, **kwargs):
 398         return super().__new__(meta_cls, class_name, bases, attrs)
 399
 400     def __init__(cls, class_name, bases, namespace, **kwargs):
 401         super().__init__(class_name, bases, namespace)
 402
 403         # skip our own bases; they are never directly instantiated by the user
 404         own_bases = (
 405             '_UserComponent',
 406             '_UserFilterSinkComponent',
 407             '_UserSourceComponent',
 408             '_UserFilterComponent',
 409             '_UserSinkComponent',
 410         )
 411
 412         if class_name in own_bases:
 413             return
 414
 415         comp_cls_name = kwargs.get('name', class_name)
 416         utils._check_str(comp_cls_name)
 417         comp_cls_descr = None
 418         comp_cls_help = None
 419
 420         if hasattr(cls, '__doc__') and cls.__doc__ is not None:
 421             utils._check_str(cls.__doc__)
 422             docstring = _trim_docstring(cls.__doc__)
 423             lines = docstring.splitlines()
 424
 425             if len(lines) >= 1:
 426                 comp_cls_descr = lines[0]
 427
 428             if len(lines) >= 3:
 429                 comp_cls_help = '\n'.join(lines[2:])
 430
 431         iter_cls = kwargs.get('message_iterator_class')
 432
 433         if _UserSourceComponent in bases:
 434             _UserComponentType._bt_set_iterator_class(cls, iter_cls)
 435             cc_ptr = native_bt.bt2_component_class_source_create(cls,
 436                                                                  comp_cls_name,
 437                                                                  comp_cls_descr,
 438                                                                  comp_cls_help)
 439         elif _UserFilterComponent in bases:
 440             _UserComponentType._bt_set_iterator_class(cls, iter_cls)
 441             cc_ptr = native_bt.bt2_component_class_filter_create(cls,
 442                                                                  comp_cls_name,
 443                                                                  comp_cls_descr,
 444                                                                  comp_cls_help)
 445         elif _UserSinkComponent in bases:
 446             if not hasattr(cls, '_consume'):
 447                 raise bt2.IncompleteUserClass("cannot create component class '{}': missing a _consume() method".format(class_name))
 448
 449             cc_ptr = native_bt.bt2_component_class_sink_create(cls,
 450                                                                comp_cls_name,
 451                                                                comp_cls_descr,
 452                                                                comp_cls_help)
 453         else:
 454             raise bt2.IncompleteUserClass("cannot find a known component class base in the bases of '{}'".format(class_name))
 455
 456         if cc_ptr is None:
 457             raise bt2.CreationError("cannot create component class '{}'".format(class_name))
 458
 459         cls._bt_cc_ptr = cc_ptr
 460
 461     def _bt_init_from_native(cls, comp_ptr, params_ptr):
 462         # create instance, not user-initialized yet
 463         self = cls.__new__(cls)
 464
 465         # pointer to native self component object (weak/borrowed)
 466         self._bt_ptr = comp_ptr
 467
 468         # call user's __init__() method
 469         if params_ptr is not None:
 470             params = bt2.value._create_from_ptr_and_get_ref(params_ptr)
 471         else:
 472             params = None
 473
 474         self.__init__(params)
 475         return self
 476
 477     def __call__(cls, *args, **kwargs):
 478         raise bt2.Error('cannot directly instantiate a user component from a Python module')
 479
 480     @staticmethod
 481     def _bt_set_iterator_class(cls, iter_cls):
 482         if iter_cls is None:
 483             raise bt2.IncompleteUserClass("cannot create component class '{}': missing message iterator class".format(cls.__name__))
 484
 485         if not issubclass(iter_cls, bt2.message_iterator._UserMessageIterator):
 486             raise bt2.IncompleteUserClass("cannot create component class '{}': message iterator class does not inherit bt2._UserMessageIterator".format(cls.__name__))
 487
 488         if not hasattr(iter_cls, '__next__'):
 489             raise bt2.IncompleteUserClass("cannot create component class '{}': message iterator class is missing a __next__() method".format(cls.__name__))
 490
 491         cls._iter_cls = iter_cls
 492
 493     @property
 494     def name(cls):
 495         ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
 496         return native_bt.component_class_get_name(ptr)
 497
 498     @property
 499     def description(cls):
 500         ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
 501         return native_bt.component_class_get_description(ptr)
 502
 503     @property
 504     def help(cls):
 505         ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
 506         return native_bt.component_class_get_help(ptr)
 507
 508     @property
 509     def addr(cls):
 510         return int(cls._bt_cc_ptr)
 511
 512     def _bt_query_from_native(cls, query_exec_ptr, obj, params_ptr, log_level):
 513         # this can raise, in which case the native call to
 514         # bt_component_class_query() returns NULL
 515         if params_ptr is not None:
 516             params = bt2.value._create_from_ptr_and_get_ref(params_ptr)
 517         else:
 518             params = None
 519
 520         query_exec = bt2.QueryExecutor._create_from_ptr_and_get_ref(
 521             query_exec_ptr)
 522
 523         # this can raise, but the native side checks the exception
 524         results = cls._query(query_exec, obj, params, log_level)
 525
 526         # this can raise, but the native side checks the exception
 527         results = bt2.create_value(results)
 528
 529         if results is None:
 530             results_ptr = native_bt.value_null
 531         else:
 532             # return new reference
 533             results_ptr = results._ptr
 534
 535         # We return a new reference.
 536         bt2.value._Value._get_ref(results_ptr)
 537
 538         return int(results_ptr)
 539
 540     def _query(cls, query_executor, obj, params, log_level):
 541         raise NotImplementedError
 542
 543     def _bt_component_class_ptr(self):
 544         return self._bt_as_component_class_ptr(self._bt_cc_ptr)
 545
 546     def __del__(cls):
 547         if hasattr(cls, '_bt_cc_ptr'):
 548             cc_ptr = cls._bt_as_component_class_ptr(cls._bt_cc_ptr)
 549             native_bt.component_class_put_ref(cc_ptr)
 550
 551 # Subclasses must provide these methods or property:
 552 #
 553 #   - _bt_as_not_self_specific_component_ptr: static method, must return the passed
 554 #     specialized self component pointer (e.g. 'bt_self_component_sink *') as a
 555 #     specialized non-self pointer (e.g. 'bt_component_sink *').
 556 #   - _bt_borrow_component_class_ptr: static method, must return a pointer to the
 557 #     specialized component class (e.g. 'bt_component_class_sink *') of the
 558 #     passed specialized component pointer (e.g. 'bt_component_sink *').
 559 #   - _bt_comp_cls_type: property, one of the native_bt.COMPONENT_CLASS_TYPE_*
 560 #     constants.
 561
 562 class _UserComponent(metaclass=_UserComponentType):
 563     @property
 564     def name(self):
 565         ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
 566         ptr = self._bt_as_component_ptr(ptr)
 567         name = native_bt.component_get_name(ptr)
 568         assert name is not None
 569         return name
 570
 571     @property
 572     def logging_level(self):
 573         ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
 574         ptr = self._bt_as_component_ptr(ptr)
 575         return native_bt.component_get_logging_level(ptr)
 576
 577     @property
 578     def cls(self):
 579         comp_ptr = self._bt_as_not_self_specific_component_ptr(self._bt_ptr)
 580         cc_ptr = self._bt_borrow_component_class_ptr(comp_ptr)
 581         return _create_component_class_from_ptr_and_get_ref(cc_ptr, self._bt_comp_cls_type)
 582
 583     @property
 584     def addr(self):
 585         return int(self._bt_ptr)
 586
 587     def __init__(self, params=None):
 588         pass
 589
 590     def _finalize(self):
 591         pass
 592
 593     def _port_connected(self, port, other_port):
 594         pass
 595
 596     def _bt_port_connected_from_native(self, self_port_ptr, self_port_type, other_port_ptr):
 597         port = bt2.port._create_self_from_ptr_and_get_ref(
 598             self_port_ptr, self_port_type)
 599
 600         if self_port_type == native_bt.PORT_TYPE_OUTPUT:
 601             other_port_type = native_bt.PORT_TYPE_INPUT
 602         else:
 603             other_port_type = native_bt.PORT_TYPE_OUTPUT
 604
 605         other_port = bt2.port._create_from_ptr_and_get_ref(
 606             other_port_ptr, other_port_type)
 607         self._port_connected(port, other_port)
 608
 609     def _bt_graph_is_configured_from_native(self):
 610         self._graph_is_configured()
 611
 612     def _create_trace_class(self, assigns_automatic_stream_class_id=True):
 613         ptr = self._bt_as_self_component_ptr(self._bt_ptr)
 614         tc_ptr = native_bt.trace_class_create(ptr)
 615
 616         if tc_ptr is None:
 617             raise bt2.CreationError('could not create trace class')
 618
 619         tc = bt2._TraceClass._create_from_ptr(tc_ptr)
 620         tc._assigns_automatic_stream_class_id = assigns_automatic_stream_class_id
 621
 622         return tc
 623
 624     def _create_clock_class(self, frequency=None, name=None, description=None,
 625                             precision=None, offset=None, origin_is_unix_epoch=True,
 626                             uuid=None):
 627         ptr = self._bt_as_self_component_ptr(self._bt_ptr)
 628         cc_ptr = native_bt.clock_class_create(ptr)
 629
 630         if cc_ptr is None:
 631             raise bt2.CreationError('could not create clock class')
 632
 633         cc = bt2.clock_class._ClockClass._create_from_ptr(cc_ptr)
 634
 635         if frequency is not None:
 636             cc._frequency = frequency
 637
 638         if name is not None:
 639             cc._name = name
 640
 641         if description is not None:
 642             cc._description = description
 643
 644         if precision is not None:
 645             cc._precision = precision
 646
 647         if offset is not None:
 648             cc._offset = offset
 649
 650         cc._origin_is_unix_epoch = origin_is_unix_epoch
 651
 652         if uuid is not None:
 653             cc._uuid = uuid
 654
 655         return cc
 656
 657
 658 class _UserSourceComponent(_UserComponent, _SourceComponent):
 659     _bt_as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_source_as_component_source)
 660     _bt_as_self_component_ptr = staticmethod(native_bt.self_component_source_as_self_component)
 661
 662     @property
 663     def _output_ports(self):
 664         def get_output_port_count(self_ptr):
 665             ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
 666             return native_bt.component_source_get_output_port_count(ptr)
 667
 668         return _ComponentPorts(self._bt_ptr,
 669                                native_bt.self_component_source_borrow_output_port_by_name,
 670                                native_bt.self_component_source_borrow_output_port_by_index,
 671                                get_output_port_count,
 672                                bt2.port._UserComponentOutputPort)
 673
 674     def _add_output_port(self, name, user_data=None):
 675         utils._check_str(name)
 676         fn = native_bt.self_component_source_add_output_port
 677         comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
 678         utils._handle_func_status(comp_status,
 679                                   'cannot add output port to source component object')
 680         assert self_port_ptr is not None
 681         return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
 682
 683
 684 class _UserFilterComponent(_UserComponent, _FilterComponent):
 685     _bt_as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_filter_as_component_filter)
 686     _bt_as_self_component_ptr = staticmethod(native_bt.self_component_filter_as_self_component)
 687
 688     @property
 689     def _output_ports(self):
 690         def get_output_port_count(self_ptr):
 691             ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
 692             return native_bt.component_filter_get_output_port_count(ptr)
 693
 694         return _ComponentPorts(self._bt_ptr,
 695                                native_bt.self_component_filter_borrow_output_port_by_name,
 696                                native_bt.self_component_filter_borrow_output_port_by_index,
 697                                get_output_port_count,
 698                                bt2.port._UserComponentOutputPort)
 699
 700     @property
 701     def _input_ports(self):
 702         def get_input_port_count(self_ptr):
 703             ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
 704             return native_bt.component_filter_get_input_port_count(ptr)
 705
 706         return _ComponentPorts(self._bt_ptr,
 707                                native_bt.self_component_filter_borrow_input_port_by_name,
 708                                native_bt.self_component_filter_borrow_input_port_by_index,
 709                                get_input_port_count,
 710                                bt2.port._UserComponentInputPort)
 711
 712     def _add_output_port(self, name, user_data=None):
 713         utils._check_str(name)
 714         fn = native_bt.self_component_filter_add_output_port
 715         comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
 716         utils._handle_func_status(comp_status,
 717                                   'cannot add output port to filter component object')
 718         assert self_port_ptr
 719         return bt2.port._UserComponentOutputPort._create_from_ptr(self_port_ptr)
 720
 721     def _add_input_port(self, name, user_data=None):
 722         utils._check_str(name)
 723         fn = native_bt.self_component_filter_add_input_port
 724         comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
 725         utils._handle_func_status(comp_status,
 726                                   'cannot add input port to filter component object')
 727         assert self_port_ptr
 728         return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr)
 729
 730
 731 class _UserSinkComponent(_UserComponent, _SinkComponent):
 732     _bt_as_not_self_specific_component_ptr = staticmethod(native_bt.self_component_sink_as_component_sink)
 733     _bt_as_self_component_ptr = staticmethod(native_bt.self_component_sink_as_self_component)
 734
 735     @property
 736     def _input_ports(self):
 737         def get_input_port_count(self_ptr):
 738             ptr = self._bt_as_not_self_specific_component_ptr(self_ptr)
 739             return native_bt.component_sink_get_input_port_count(ptr)
 740
 741         return _ComponentPorts(self._bt_ptr,
 742                                native_bt.self_component_sink_borrow_input_port_by_name,
 743                                native_bt.self_component_sink_borrow_input_port_by_index,
 744                                get_input_port_count,
 745                                bt2.port._UserComponentInputPort)
 746
 747     def _add_input_port(self, name, user_data=None):
 748         utils._check_str(name)
 749         fn = native_bt.self_component_sink_add_input_port
 750         comp_status, self_port_ptr = fn(self._bt_ptr, name, user_data)
 751         utils._handle_func_status(comp_status,
 752                                   'cannot add input port to sink component object')
 753         assert self_port_ptr
 754         return bt2.port._UserComponentInputPort._create_from_ptr(self_port_ptr)