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