1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
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:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
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
23 from bt2
import native_bt
, object, utils
25 import collections
.abc
30 class _MessageIterator(collections
.abc
.Iterator
):
31 def _handle_status(self
, status
, gen_error_msg
):
32 if status
== native_bt
.MESSAGE_ITERATOR_STATUS_AGAIN
:
34 elif status
== native_bt
.MESSAGE_ITERATOR_STATUS_END
:
37 raise bt2
.Error(gen_error_msg
)
40 raise NotImplementedError
43 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
44 def __init__(self
, ptr
):
45 self
._current
_msgs
= []
50 if len(self
._current
_msgs
) == self
._at
:
51 status
, msgs
= self
._get
_msg
_range
(self
._ptr
)
52 self
._handle
_status
(status
,
53 'unexpected error: cannot advance the message iterator')
54 self
._current
_msgs
= msgs
57 msg_ptr
= self
._current
_msgs
[self
._at
]
60 return bt2
.message
._create
_from
_ptr
(msg_ptr
)
63 class _UserComponentInputPortMessageIterator(_GenericMessageIterator
):
64 _get_msg_range
= staticmethod(native_bt
.py3_self_component_port_input_get_msg_range
)
68 comp_ptr
= native_bt
.private_connection_message_iterator_get_component(self
._ptr
)
70 return bt2
.component
._create
_generic
_component
_from
_ptr
(comp_ptr
)
73 class _OutputPortMessageIterator(_GenericMessageIterator
):
74 _get_msg_range
= staticmethod(native_bt
.py3_port_output_get_msg_range
)
75 _get_ref
= staticmethod(native_bt
.port_output_message_iterator_get_ref
)
76 _put_ref
= staticmethod(native_bt
.port_output_message_iterator_put_ref
)
79 class _UserMessageIterator(_MessageIterator
):
80 def __new__(cls
, ptr
):
81 # User iterator objects are always created by the native side,
82 # that is, never instantiated directly by Python code.
84 # The native code calls this, then manually calls
85 # self.__init__() without the `ptr` argument. The user has
86 # access to self.component during this call, thanks to this
87 # self._ptr argument being set.
89 # self._ptr is NOT owned by this object here, so there's nothing
91 self
= super().__new
__(cls
)
100 return native_bt
.py3_get_user_component_from_user_msg_iter(self
._ptr
)
104 return int(self
._ptr
)
112 def _next_from_native(self
):
113 # this can raise anything: it's catched by the native part
116 except StopIteration:
121 utils
._check
_type
(msg
, bt2
.message
._Message
)
123 # Release the reference to the native part.
127 # Validate that the presence or lack of presence of a
128 # `default_clock_snapshot` value is valid in the context of `stream_class`.
130 def _validate_default_clock_snapshot(stream_class
, default_clock_snapshot
):
131 stream_class_has_default_clock_class
= stream_class
.default_clock_class
is not None
133 if stream_class_has_default_clock_class
and default_clock_snapshot
is None:
135 'stream class has a default clock class, default_clock_snapshot should not be None')
137 if not stream_class_has_default_clock_class
and default_clock_snapshot
is not None:
139 'stream class has no default clock class, default_clock_snapshot should be None')
141 def _create_event_message(self
, event_class
, packet
, default_clock_snapshot
=None):
142 utils
._check
_type
(event_class
, bt2
.event_class
.EventClass
)
143 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
144 self
._validate
_default
_clock
_snapshot
(packet
.stream
.stream_class
, default_clock_snapshot
)
146 if default_clock_snapshot
is not None:
147 utils
._check
_uint
64(default_clock_snapshot
)
148 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
149 self
._ptr
, event_class
._ptr
, packet
._ptr
, default_clock_snapshot
)
151 ptr
= native_bt
.message_event_create(
152 self
._ptr
, event_class
._ptr
, packet
._ptr
)
155 raise bt2
.CreationError('cannot create event message object')
157 return bt2
.message
._EventMessage
(ptr
)
159 def _create_stream_beginning_message(self
, stream
):
160 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
162 ptr
= native_bt
.message_stream_beginning_create(self
._ptr
, stream
._ptr
)
164 raise bt2
.CreationError('cannot create stream beginning message object')
166 return bt2
.message
._StreamBeginningMessage
(ptr
)
168 def _create_stream_end_message(self
, stream
):
169 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
171 ptr
= native_bt
.message_stream_end_create(self
._ptr
, stream
._ptr
)
173 raise bt2
.CreationError('cannot create stream end message object')
175 return bt2
.message
._StreamEndMessage
(ptr
)
177 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
178 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
180 if packet
.stream
.stream_class
.packets_have_default_beginning_clock_snapshot
:
181 if default_clock_snapshot
is None:
182 raise bt2
.CreationError("packet beginning messages in this stream must have a default clock snapshots")
184 utils
._check
_uint
64(default_clock_snapshot
)
185 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
186 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
188 if default_clock_snapshot
is not None:
189 raise bt2
.CreationError("packet beginning messages in this stream must not have a default clock snapshots")
191 ptr
= native_bt
.message_packet_beginning_create(self
._ptr
, packet
._ptr
)
194 raise bt2
.CreationError('cannot create packet beginning message object')
196 return bt2
.message
._PacketBeginningMessage
(ptr
)
198 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
199 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
200 self
._validate
_default
_clock
_snapshot
(packet
.stream
.stream_class
, default_clock_snapshot
)
202 if default_clock_snapshot
is not None:
203 utils
._check
_uint
64(default_clock_snapshot
)
204 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
205 self
._ptr
, packet
._ptr
, default_clock_snapshot
)
207 ptr
= native_bt
.message_packet_end_create(self
._ptr
, packet
._ptr
)
210 raise bt2
.CreationError('cannot create packet end message object')
212 return bt2
.message
._PacketEndMessage
(ptr
)