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 _handle_status(self, status, gen_error_msg): |
2ae9f48c | 32 | if status == native_bt.MESSAGE_ITERATOR_STATUS_AGAIN: |
811644b8 | 33 | raise bt2.TryAgain |
5602ef81 | 34 | elif status == native_bt.MESSAGE_ITERATOR_STATUS_END: |
81447b5b | 35 | raise bt2.Stop |
81447b5b PP |
36 | elif status < 0: |
37 | raise bt2.Error(gen_error_msg) | |
38 | ||
81447b5b | 39 | def __next__(self): |
811644b8 | 40 | raise NotImplementedError |
81447b5b PP |
41 | |
42 | ||
78288f58 | 43 | class _GenericMessageIterator(object._SharedObject, _MessageIterator): |
2ae9f48c SM |
44 | def __init__(self, ptr): |
45 | self._current_msgs = [] | |
46 | self._at = 0 | |
47 | super().__init__(ptr) | |
811644b8 PP |
48 | |
49 | def __next__(self): | |
2ae9f48c SM |
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 | |
55 | self._at = 0 | |
56 | ||
57 | msg_ptr = self._current_msgs[self._at] | |
58 | self._at += 1 | |
59 | ||
60 | return bt2.message._create_from_ptr(msg_ptr) | |
81447b5b | 61 | |
811644b8 | 62 | |
5602ef81 | 63 | class _PrivateConnectionMessageIterator(_GenericMessageIterator): |
90157d89 PP |
64 | @property |
65 | def component(self): | |
5602ef81 | 66 | comp_ptr = native_bt.private_connection_message_iterator_get_component(self._ptr) |
90157d89 PP |
67 | assert(comp_ptr) |
68 | return bt2.component._create_generic_component_from_ptr(comp_ptr) | |
69 | ||
70 | ||
5602ef81 | 71 | class _OutputPortMessageIterator(_GenericMessageIterator): |
2ae9f48c SM |
72 | _get_msg_range = staticmethod(native_bt.py3_port_output_get_msg_range) |
73 | _get_ref = staticmethod(native_bt.port_output_message_iterator_get_ref) | |
74 | _put_ref = staticmethod(native_bt.port_output_message_iterator_put_ref) | |
dc43190b PP |
75 | |
76 | ||
5602ef81 | 77 | class _UserMessageIterator(_MessageIterator): |
81447b5b | 78 | def __new__(cls, ptr): |
811644b8 | 79 | # User iterator objects are always created by the native side, |
81447b5b PP |
80 | # that is, never instantiated directly by Python code. |
81 | # | |
811644b8 PP |
82 | # The native code calls this, then manually calls |
83 | # self.__init__() without the `ptr` argument. The user has | |
84 | # access to self.component during this call, thanks to this | |
85 | # self._ptr argument being set. | |
81447b5b PP |
86 | # |
87 | # self._ptr is NOT owned by this object here, so there's nothing | |
88 | # to do in __del__(). | |
89 | self = super().__new__(cls) | |
90 | self._ptr = ptr | |
91 | return self | |
92 | ||
93 | def __init__(self): | |
94 | pass | |
95 | ||
96 | @property | |
811644b8 | 97 | def _component(self): |
5602ef81 | 98 | return native_bt.py3_get_user_component_from_user_msg_iter(self._ptr) |
81447b5b PP |
99 | |
100 | @property | |
101 | def addr(self): | |
102 | return int(self._ptr) | |
103 | ||
811644b8 | 104 | def _finalize(self): |
81447b5b PP |
105 | pass |
106 | ||
811644b8 PP |
107 | def __next__(self): |
108 | raise bt2.Stop | |
109 | ||
110 | def _next_from_native(self): | |
111 | # this can raise anything: it's catched by the native part | |
112 | try: | |
5602ef81 | 113 | msg = next(self) |
811644b8 PP |
114 | except StopIteration: |
115 | raise bt2.Stop | |
116 | except: | |
117 | raise | |
118 | ||
5602ef81 | 119 | utils._check_type(msg, bt2.message._Message) |
81447b5b | 120 | |
2ae9f48c SM |
121 | # Release the reference to the native part. |
122 | ptr = msg._release() | |
123 | return int(ptr) | |
124 | ||
125 | # Validate that the presence or lack of presence of a | |
126 | # `default_clock_snapshot` value is valid in the context of `stream_class`. | |
127 | @staticmethod | |
128 | def _validate_default_clock_snapshot(stream_class, default_clock_snapshot): | |
129 | stream_class_has_default_clock_class = stream_class.default_clock_class is not None | |
130 | ||
131 | if stream_class_has_default_clock_class and default_clock_snapshot is None: | |
132 | raise bt2.Error( | |
133 | 'stream class has a default clock class, default_clock_snapshot should not be None') | |
134 | ||
135 | if not stream_class_has_default_clock_class and default_clock_snapshot is not None: | |
136 | raise bt2.Error( | |
137 | 'stream class has no default clock class, default_clock_snapshot should be None') | |
138 | ||
139 | def _create_event_message(self, event_class, packet, default_clock_snapshot=None): | |
140 | utils._check_type(event_class, bt2.event_class.EventClass) | |
141 | utils._check_type(packet, bt2.packet._Packet) | |
142 | self._validate_default_clock_snapshot(packet.stream.stream_class, default_clock_snapshot) | |
143 | ||
144 | if default_clock_snapshot is not None: | |
145 | utils._check_uint64(default_clock_snapshot) | |
146 | ptr = native_bt.message_event_create_with_default_clock_snapshot( | |
147 | self._ptr, event_class._ptr, packet._ptr, default_clock_snapshot) | |
148 | else: | |
149 | ptr = native_bt.message_event_create( | |
150 | self._ptr, event_class._ptr, packet._ptr) | |
151 | ||
152 | if ptr is None: | |
153 | raise bt2.CreationError('cannot create event message object') | |
154 | ||
155 | return bt2.message._EventMessage(ptr) | |
156 | ||
157 | def _create_stream_beginning_message(self, stream): | |
158 | utils._check_type(stream, bt2.stream._Stream) | |
159 | ||
160 | ptr = native_bt.message_stream_beginning_create(self._ptr, stream._ptr) | |
161 | if ptr is None: | |
162 | raise bt2.CreationError('cannot create stream beginning message object') | |
163 | ||
164 | return bt2.message._StreamBeginningMessage(ptr) | |
165 | ||
166 | def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): | |
167 | utils._check_type(packet, bt2.packet._Packet) | |
168 | ||
169 | if packet.stream.stream_class.packets_have_default_beginning_clock_snapshot: | |
170 | if default_clock_snapshot is None: | |
171 | raise bt2.CreationError("packet beginning messages in this stream must have a default clock snapshots") | |
172 | ||
173 | utils._check_uint64(default_clock_snapshot) | |
174 | ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot( | |
175 | self._ptr, packet._ptr, default_clock_snapshot) | |
176 | else: | |
177 | if default_clock_snapshot is not None: | |
178 | raise bt2.CreationError("packet beginning messages in this stream must not have a default clock snapshots") | |
179 | ||
180 | ptr = native_bt.message_packet_beginning_create(self._ptr, packet._ptr) | |
181 | ||
182 | if ptr is None: | |
183 | raise bt2.CreationError('cannot create packet beginning message object') | |
184 | ||
185 | return bt2.message._PacketBeginningMessage(ptr) |