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