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 | |
3fb99a22 | 24 | from bt2 import message as bt2_message |
81447b5b | 25 | import collections.abc |
3fb99a22 PP |
26 | from bt2 import component as bt2_component |
27 | from bt2 import stream as bt2_stream | |
28 | from bt2 import event_class as bt2_event_class | |
29 | from bt2 import packet as bt2_packet | |
30 | from bt2 import port as bt2_port | |
31 | from bt2 import clock_class as bt2_clock_class | |
81447b5b PP |
32 | import bt2 |
33 | ||
34 | ||
5602ef81 | 35 | class _MessageIterator(collections.abc.Iterator): |
81447b5b | 36 | def __next__(self): |
811644b8 | 37 | raise NotImplementedError |
81447b5b PP |
38 | |
39 | ||
78288f58 | 40 | class _GenericMessageIterator(object._SharedObject, _MessageIterator): |
2ae9f48c | 41 | def __init__(self, ptr): |
cfbd7cf3 FD |
42 | self._current_msgs = [] |
43 | self._at = 0 | |
44 | super().__init__(ptr) | |
811644b8 PP |
45 | |
46 | def __next__(self): | |
2ae9f48c SM |
47 | if len(self._current_msgs) == self._at: |
48 | status, msgs = self._get_msg_range(self._ptr) | |
cfbd7cf3 FD |
49 | utils._handle_func_status( |
50 | status, 'unexpected error: cannot advance the message iterator' | |
51 | ) | |
2ae9f48c SM |
52 | self._current_msgs = msgs |
53 | self._at = 0 | |
54 | ||
55 | msg_ptr = self._current_msgs[self._at] | |
56 | self._at += 1 | |
57 | ||
3fb99a22 | 58 | return bt2_message._create_from_ptr(msg_ptr) |
81447b5b | 59 | |
f00b8d40 SM |
60 | @property |
61 | def can_seek_beginning(self): | |
62 | res = self._can_seek_beginning(self._ptr) | |
63 | return res != 0 | |
64 | ||
65 | def seek_beginning(self): | |
66 | # Forget about buffered messages, they won't be valid after seeking.. | |
67 | self._current_msgs.clear() | |
68 | self._at = 0 | |
69 | ||
70 | status = self._seek_beginning(self._ptr) | |
cfbd7cf3 | 71 | utils._handle_func_status(status, 'cannot seek message iterator beginning') |
f00b8d40 | 72 | |
811644b8 | 73 | |
c5f330cd | 74 | # This is created when a component wants to iterate on one of its input ports. |
5f25509b | 75 | class _UserComponentInputPortMessageIterator(_GenericMessageIterator): |
d24d5663 | 76 | _get_msg_range = staticmethod(native_bt.bt2_self_component_port_input_get_msg_range) |
cfbd7cf3 FD |
77 | _get_ref = staticmethod( |
78 | native_bt.self_component_port_input_message_iterator_get_ref | |
79 | ) | |
80 | _put_ref = staticmethod( | |
81 | native_bt.self_component_port_input_message_iterator_put_ref | |
82 | ) | |
83 | _can_seek_beginning = staticmethod( | |
84 | native_bt.self_component_port_input_message_iterator_can_seek_beginning | |
85 | ) | |
86 | _seek_beginning = staticmethod( | |
87 | native_bt.self_component_port_input_message_iterator_seek_beginning | |
88 | ) | |
90157d89 PP |
89 | |
90 | ||
c5f330cd SM |
91 | # This is extended by the user to implement component classes in Python. It |
92 | # is created for a given output port when an input port message iterator is | |
93 | # created on the input port on the other side of the connection. It is also | |
94 | # created when an output port message iterator is created on this output port. | |
95 | # | |
96 | # Its purpose is to feed the messages that should go out through this output | |
97 | # port. | |
5602ef81 | 98 | class _UserMessageIterator(_MessageIterator): |
81447b5b | 99 | def __new__(cls, ptr): |
811644b8 | 100 | # User iterator objects are always created by the native side, |
81447b5b PP |
101 | # that is, never instantiated directly by Python code. |
102 | # | |
811644b8 PP |
103 | # The native code calls this, then manually calls |
104 | # self.__init__() without the `ptr` argument. The user has | |
105 | # access to self.component during this call, thanks to this | |
85906b6b | 106 | # self._bt_ptr argument being set. |
81447b5b | 107 | # |
85906b6b | 108 | # self._bt_ptr is NOT owned by this object here, so there's nothing |
81447b5b PP |
109 | # to do in __del__(). |
110 | self = super().__new__(cls) | |
85906b6b | 111 | self._bt_ptr = ptr |
81447b5b PP |
112 | return self |
113 | ||
85906b6b | 114 | def _bt_init_from_native(self, self_output_port_ptr): |
3fb99a22 | 115 | self_output_port = bt2_port._create_self_from_ptr_and_get_ref( |
cfbd7cf3 FD |
116 | self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT |
117 | ) | |
c5f330cd SM |
118 | self.__init__(self_output_port) |
119 | ||
120 | def __init__(self, output_port): | |
81447b5b PP |
121 | pass |
122 | ||
123 | @property | |
811644b8 | 124 | def _component(self): |
85906b6b | 125 | return native_bt.bt2_get_user_component_from_user_msg_iter(self._bt_ptr) |
81447b5b PP |
126 | |
127 | @property | |
128 | def addr(self): | |
85906b6b | 129 | return int(self._bt_ptr) |
81447b5b | 130 | |
9b4f9b42 PP |
131 | @property |
132 | def _is_interrupted(self): | |
133 | return bool(native_bt.self_message_iterator_is_interrupted(self._bt_ptr)) | |
134 | ||
6a91742b | 135 | def _user_finalize(self): |
81447b5b PP |
136 | pass |
137 | ||
811644b8 PP |
138 | def __next__(self): |
139 | raise bt2.Stop | |
140 | ||
85906b6b | 141 | def _bt_next_from_native(self): |
811644b8 PP |
142 | # this can raise anything: it's catched by the native part |
143 | try: | |
5602ef81 | 144 | msg = next(self) |
811644b8 PP |
145 | except StopIteration: |
146 | raise bt2.Stop | |
147 | except: | |
148 | raise | |
149 | ||
3fb99a22 | 150 | utils._check_type(msg, bt2_message._Message) |
81447b5b | 151 | |
d79a8353 SM |
152 | # The reference we return will be given to the message array. |
153 | # However, the `msg` Python object may stay alive, if the user has kept | |
154 | # a reference to it. Acquire a new reference to account for that. | |
155 | msg._get_ref(msg._ptr) | |
156 | return int(msg._ptr) | |
2ae9f48c | 157 | |
f00b8d40 | 158 | @property |
85906b6b | 159 | def _bt_can_seek_beginning_from_native(self): |
f00b8d40 SM |
160 | # Here, we mimic the behavior of the C API: |
161 | # | |
6a91742b PP |
162 | # - If the iterator has a _user_can_seek_beginning attribute, |
163 | # read it and use that result. | |
f00b8d40 SM |
164 | # - Otherwise, the presence or absence of a `_seek_beginning` |
165 | # method indicates whether the iterator can seek beginning. | |
6a91742b PP |
166 | if hasattr(self, '_user_can_seek_beginning'): |
167 | can_seek_beginning = self._user_can_seek_beginning | |
f00b8d40 SM |
168 | utils._check_bool(can_seek_beginning) |
169 | return can_seek_beginning | |
170 | else: | |
6a91742b | 171 | return hasattr(self, '_user_seek_beginning') |
f00b8d40 | 172 | |
85906b6b | 173 | def _bt_seek_beginning_from_native(self): |
6a91742b | 174 | self._user_seek_beginning() |
f00b8d40 | 175 | |
ca02df0a | 176 | def _create_input_port_message_iterator(self, input_port): |
3fb99a22 | 177 | utils._check_type(input_port, bt2_port._UserComponentInputPort) |
ca02df0a PP |
178 | |
179 | msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_message_iterator( | |
180 | self._bt_ptr, input_port._ptr | |
181 | ) | |
182 | ||
183 | if msg_iter_ptr is None: | |
184 | raise bt2.CreationError('cannot create message iterator object') | |
185 | ||
186 | return _UserComponentInputPortMessageIterator(msg_iter_ptr) | |
187 | ||
cfbd7cf3 FD |
188 | def _create_event_message( |
189 | self, event_class, parent=None, default_clock_snapshot=None | |
190 | ): | |
3fb99a22 | 191 | utils._check_type(event_class, bt2_event_class._EventClass) |
26fc5aed PP |
192 | |
193 | if event_class.stream_class.supports_packets: | |
3fb99a22 | 194 | utils._check_type(parent, bt2_packet._Packet) |
26fc5aed | 195 | else: |
3fb99a22 | 196 | utils._check_type(parent, bt2_stream._Stream) |
2ae9f48c SM |
197 | |
198 | if default_clock_snapshot is not None: | |
c6af194f | 199 | if event_class.stream_class.default_clock_class is None: |
cfbd7cf3 FD |
200 | raise ValueError( |
201 | 'event messages in this stream must not have a default clock snapshot' | |
202 | ) | |
c6af194f | 203 | |
2ae9f48c | 204 | utils._check_uint64(default_clock_snapshot) |
26fc5aed PP |
205 | |
206 | if event_class.stream_class.supports_packets: | |
207 | ptr = native_bt.message_event_create_with_packet_and_default_clock_snapshot( | |
cfbd7cf3 FD |
208 | self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot |
209 | ) | |
26fc5aed PP |
210 | else: |
211 | ptr = native_bt.message_event_create_with_default_clock_snapshot( | |
cfbd7cf3 FD |
212 | self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot |
213 | ) | |
2ae9f48c | 214 | else: |
c6af194f | 215 | if event_class.stream_class.default_clock_class is not None: |
cfbd7cf3 FD |
216 | raise ValueError( |
217 | 'event messages in this stream must have a default clock snapshot' | |
218 | ) | |
c6af194f | 219 | |
26fc5aed PP |
220 | if event_class.stream_class.supports_packets: |
221 | ptr = native_bt.message_event_create_with_packet( | |
cfbd7cf3 FD |
222 | self._bt_ptr, event_class._ptr, parent._ptr |
223 | ) | |
26fc5aed PP |
224 | else: |
225 | ptr = native_bt.message_event_create( | |
cfbd7cf3 FD |
226 | self._bt_ptr, event_class._ptr, parent._ptr |
227 | ) | |
2ae9f48c SM |
228 | |
229 | if ptr is None: | |
694c792b | 230 | raise bt2._MemoryError('cannot create event message object') |
2ae9f48c | 231 | |
3fb99a22 | 232 | return bt2_message._EventMessage(ptr) |
2ae9f48c | 233 | |
9ec609ec | 234 | def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot): |
3fb99a22 | 235 | utils._check_type(clock_class, bt2_clock_class._ClockClass) |
9ec609ec | 236 | ptr = native_bt.message_message_iterator_inactivity_create( |
cfbd7cf3 FD |
237 | self._bt_ptr, clock_class._ptr, clock_snapshot |
238 | ) | |
9ec609ec SM |
239 | |
240 | if ptr is None: | |
694c792b | 241 | raise bt2._MemoryError('cannot create inactivity message object') |
9ec609ec | 242 | |
3fb99a22 | 243 | return bt2_message._MessageIteratorInactivityMessage(ptr) |
9ec609ec | 244 | |
188edac1 | 245 | def _create_stream_beginning_message(self, stream, default_clock_snapshot=None): |
3fb99a22 | 246 | utils._check_type(stream, bt2_stream._Stream) |
2ae9f48c | 247 | |
85906b6b | 248 | ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr) |
2ae9f48c | 249 | if ptr is None: |
694c792b | 250 | raise bt2._MemoryError('cannot create stream beginning message object') |
2ae9f48c | 251 | |
3fb99a22 | 252 | msg = bt2_message._StreamBeginningMessage(ptr) |
9ec609ec | 253 | |
188edac1 SM |
254 | if default_clock_snapshot is not None: |
255 | msg._default_clock_snapshot = default_clock_snapshot | |
9ec609ec | 256 | |
9ec609ec SM |
257 | return msg |
258 | ||
188edac1 | 259 | def _create_stream_end_message(self, stream, default_clock_snapshot=None): |
3fb99a22 | 260 | utils._check_type(stream, bt2_stream._Stream) |
5f25509b | 261 | |
85906b6b | 262 | ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr) |
5f25509b | 263 | if ptr is None: |
694c792b | 264 | raise bt2._MemoryError('cannot create stream end message object') |
5f25509b | 265 | |
3fb99a22 | 266 | msg = bt2_message._StreamEndMessage(ptr) |
188edac1 SM |
267 | |
268 | if default_clock_snapshot is not None: | |
269 | msg._default_clock_snapshot = default_clock_snapshot | |
270 | ||
271 | return msg | |
5f25509b | 272 | |
2ae9f48c | 273 | def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): |
3fb99a22 | 274 | utils._check_type(packet, bt2_packet._Packet) |
2ae9f48c | 275 | |
e8ac1aae | 276 | if packet.stream.cls.packets_have_beginning_default_clock_snapshot: |
2ae9f48c | 277 | if default_clock_snapshot is None: |
cfbd7cf3 FD |
278 | raise ValueError( |
279 | "packet beginning messages in this stream must have a default clock snapshot" | |
280 | ) | |
2ae9f48c SM |
281 | |
282 | utils._check_uint64(default_clock_snapshot) | |
283 | ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot( | |
cfbd7cf3 FD |
284 | self._bt_ptr, packet._ptr, default_clock_snapshot |
285 | ) | |
2ae9f48c SM |
286 | else: |
287 | if default_clock_snapshot is not None: | |
cfbd7cf3 FD |
288 | raise ValueError( |
289 | "packet beginning messages in this stream must not have a default clock snapshot" | |
290 | ) | |
2ae9f48c | 291 | |
85906b6b | 292 | ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr) |
2ae9f48c SM |
293 | |
294 | if ptr is None: | |
694c792b | 295 | raise bt2._MemoryError('cannot create packet beginning message object') |
2ae9f48c | 296 | |
3fb99a22 | 297 | return bt2_message._PacketBeginningMessage(ptr) |
5f25509b SM |
298 | |
299 | def _create_packet_end_message(self, packet, default_clock_snapshot=None): | |
3fb99a22 | 300 | utils._check_type(packet, bt2_packet._Packet) |
5f25509b | 301 | |
e8ac1aae | 302 | if packet.stream.cls.packets_have_end_default_clock_snapshot: |
9ec609ec | 303 | if default_clock_snapshot is None: |
cfbd7cf3 FD |
304 | raise ValueError( |
305 | "packet end messages in this stream must have a default clock snapshot" | |
306 | ) | |
9ec609ec | 307 | |
5f25509b SM |
308 | utils._check_uint64(default_clock_snapshot) |
309 | ptr = native_bt.message_packet_end_create_with_default_clock_snapshot( | |
cfbd7cf3 FD |
310 | self._bt_ptr, packet._ptr, default_clock_snapshot |
311 | ) | |
5f25509b | 312 | else: |
9ec609ec | 313 | if default_clock_snapshot is not None: |
cfbd7cf3 FD |
314 | raise ValueError( |
315 | "packet end messages in this stream must not have a default clock snapshot" | |
316 | ) | |
9ec609ec | 317 | |
85906b6b | 318 | ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr) |
5f25509b SM |
319 | |
320 | if ptr is None: | |
694c792b | 321 | raise bt2._MemoryError('cannot create packet end message object') |
5f25509b | 322 | |
3fb99a22 | 323 | return bt2_message._PacketEndMessage(ptr) |
9ec609ec | 324 | |
cfbd7cf3 FD |
325 | def _create_discarded_events_message( |
326 | self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None | |
327 | ): | |
3fb99a22 | 328 | utils._check_type(stream, bt2_stream._Stream) |
9ec609ec | 329 | |
e8ac1aae | 330 | if not stream.cls.supports_discarded_events: |
2e90378a PP |
331 | raise ValueError('stream class does not support discarded events') |
332 | ||
e8ac1aae | 333 | if stream.cls.discarded_events_have_default_clock_snapshots: |
2e90378a | 334 | if beg_clock_snapshot is None or end_clock_snapshot is None: |
cfbd7cf3 FD |
335 | raise ValueError( |
336 | 'discarded events have default clock snapshots for this stream class' | |
337 | ) | |
2e90378a | 338 | |
9ec609ec SM |
339 | utils._check_uint64(beg_clock_snapshot) |
340 | utils._check_uint64(end_clock_snapshot) | |
341 | ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots( | |
cfbd7cf3 FD |
342 | self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot |
343 | ) | |
9ec609ec | 344 | else: |
2e90378a | 345 | if beg_clock_snapshot is not None or end_clock_snapshot is not None: |
cfbd7cf3 FD |
346 | raise ValueError( |
347 | 'discarded events have no default clock snapshots for this stream class' | |
348 | ) | |
2e90378a | 349 | |
cfbd7cf3 | 350 | ptr = native_bt.message_discarded_events_create(self._bt_ptr, stream._ptr) |
9ec609ec SM |
351 | |
352 | if ptr is None: | |
694c792b | 353 | raise bt2._MemoryError('cannot discarded events message object') |
9ec609ec | 354 | |
3fb99a22 | 355 | msg = bt2_message._DiscardedEventsMessage(ptr) |
9ec609ec SM |
356 | |
357 | if count is not None: | |
358 | msg._count = count | |
359 | ||
360 | return msg | |
361 | ||
cfbd7cf3 FD |
362 | def _create_discarded_packets_message( |
363 | self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None | |
364 | ): | |
3fb99a22 | 365 | utils._check_type(stream, bt2_stream._Stream) |
9ec609ec | 366 | |
e8ac1aae | 367 | if not stream.cls.supports_discarded_packets: |
2e90378a PP |
368 | raise ValueError('stream class does not support discarded packets') |
369 | ||
e8ac1aae | 370 | if stream.cls.discarded_packets_have_default_clock_snapshots: |
2e90378a | 371 | if beg_clock_snapshot is None or end_clock_snapshot is None: |
cfbd7cf3 FD |
372 | raise ValueError( |
373 | 'discarded packets have default clock snapshots for this stream class' | |
374 | ) | |
2e90378a | 375 | |
9ec609ec SM |
376 | utils._check_uint64(beg_clock_snapshot) |
377 | utils._check_uint64(end_clock_snapshot) | |
378 | ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots( | |
cfbd7cf3 FD |
379 | self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot |
380 | ) | |
9ec609ec | 381 | else: |
2e90378a | 382 | if beg_clock_snapshot is not None or end_clock_snapshot is not None: |
cfbd7cf3 FD |
383 | raise ValueError( |
384 | 'discarded packets have no default clock snapshots for this stream class' | |
385 | ) | |
2e90378a | 386 | |
cfbd7cf3 | 387 | ptr = native_bt.message_discarded_packets_create(self._bt_ptr, stream._ptr) |
9ec609ec SM |
388 | |
389 | if ptr is None: | |
694c792b | 390 | raise bt2._MemoryError('cannot discarded packets message object') |
9ec609ec | 391 | |
3fb99a22 | 392 | msg = bt2_message._DiscardedPacketsMessage(ptr) |
9ec609ec SM |
393 | |
394 | if count is not None: | |
395 | msg._count = count | |
396 | ||
397 | return msg |