lib: make can_seek_ns_from_origin logic use `can_seek_forward` property of iterator
[babeltrace.git] / src / bindings / python / bt2 / bt2 / message_iterator.py
index 23d6fbd5d0b28d4063b7fb7e325709560bd33267..253fbcc73c4c9cdd63488fd381dc2fc671274e3f 100644 (file)
@@ -36,7 +36,14 @@ class _MessageIterator(collections.abc.Iterator):
         raise NotImplementedError
 
 
-class _GenericMessageIterator(object._SharedObject, _MessageIterator):
+class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageIterator):
+    _get_ref = staticmethod(
+        native_bt.self_component_port_input_message_iterator_get_ref
+    )
+    _put_ref = staticmethod(
+        native_bt.self_component_port_input_message_iterator_put_ref
+    )
+
     def __init__(self, ptr):
         self._current_msgs = []
         self._at = 0
@@ -44,7 +51,9 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator):
 
     def __next__(self):
         if len(self._current_msgs) == self._at:
-            status, msgs = self._get_msg_range(self._ptr)
+            status, msgs = native_bt.bt2_self_component_port_input_get_msg_range(
+                self._ptr
+            )
             utils._handle_func_status(
                 status, 'unexpected error: cannot advance the message iterator'
             )
@@ -56,35 +65,69 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator):
 
         return bt2_message._create_from_ptr(msg_ptr)
 
-    @property
     def can_seek_beginning(self):
-        res = self._can_seek_beginning(self._ptr)
+        status, res = native_bt.self_component_port_input_message_iterator_can_seek_beginning(
+            self._ptr
+        )
+        utils._handle_func_status(
+            status,
+            'cannot check whether or not message iterator can seek its beginning',
+        )
         return res != 0
 
     def seek_beginning(self):
-        # Forget about buffered messages, they won't be valid after seeking..
+        # Forget about buffered messages, they won't be valid after seeking.
         self._current_msgs.clear()
         self._at = 0
 
-        status = self._seek_beginning(self._ptr)
+        status = native_bt.self_component_port_input_message_iterator_seek_beginning(
+            self._ptr
+        )
         utils._handle_func_status(status, 'cannot seek message iterator beginning')
 
+    def can_seek_ns_from_origin(self, ns_from_origin):
+        utils._check_int64(ns_from_origin)
+        status, res = native_bt.self_component_port_input_message_iterator_can_seek_ns_from_origin(
+            self._ptr, ns_from_origin
+        )
+        utils._handle_func_status(
+            status,
+            'cannot check whether or not message iterator can seek given ns from origin',
+        )
+        return res != 0
 
-# This is created when a component wants to iterate on one of its input ports.
-class _UserComponentInputPortMessageIterator(_GenericMessageIterator):
-    _get_msg_range = staticmethod(native_bt.bt2_self_component_port_input_get_msg_range)
-    _get_ref = staticmethod(
-        native_bt.self_component_port_input_message_iterator_get_ref
-    )
-    _put_ref = staticmethod(
-        native_bt.self_component_port_input_message_iterator_put_ref
-    )
-    _can_seek_beginning = staticmethod(
-        native_bt.self_component_port_input_message_iterator_can_seek_beginning
-    )
-    _seek_beginning = staticmethod(
-        native_bt.self_component_port_input_message_iterator_seek_beginning
-    )
+    def seek_ns_from_origin(self, ns_from_origin):
+        utils._check_int64(ns_from_origin)
+
+        # Forget about buffered messages, they won't be valid after seeking.
+        self._current_msgs.clear()
+        self._at = 0
+
+        status = native_bt.self_component_port_input_message_iterator_seek_ns_from_origin(
+            self._ptr, ns_from_origin
+        )
+        utils._handle_func_status(
+            status, 'message iterator cannot seek given ns from origin'
+        )
+
+    @property
+    def can_seek_forward(self):
+        return native_bt.self_component_port_input_message_iterator_can_seek_forward(
+            self._ptr
+        )
+
+
+class _MessageIteratorConfiguration:
+    def __init__(self, ptr):
+        self._ptr = ptr
+
+    def can_seek_forward(self, value):
+        utils._check_bool(value)
+        native_bt.self_message_iterator_configuration_set_can_seek_forward(
+            self._ptr, value
+        )
+
+    can_seek_forward = property(fset=can_seek_forward)
 
 
 # This is extended by the user to implement component classes in Python.  It
@@ -110,19 +153,28 @@ class _UserMessageIterator(_MessageIterator):
         self._bt_ptr = ptr
         return self
 
-    def _bt_init_from_native(self, self_output_port_ptr):
+    def _bt_init_from_native(self, config_ptr, self_output_port_ptr):
         self_output_port = bt2_port._create_self_from_ptr_and_get_ref(
             self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT
         )
-        self.__init__(self_output_port)
+        config = _MessageIteratorConfiguration(config_ptr)
+        self.__init__(config, self_output_port)
 
-    def __init__(self, output_port):
+    def __init__(self, config, self_output_port):
         pass
 
     @property
     def _component(self):
         return native_bt.bt2_get_user_component_from_user_msg_iter(self._bt_ptr)
 
+    @property
+    def _port(self):
+        port_ptr = native_bt.self_message_iterator_borrow_port(self._bt_ptr)
+        assert port_ptr is not None
+        return bt2_port._create_self_from_ptr_and_get_ref(
+            port_ptr, native_bt.PORT_TYPE_OUTPUT
+        )
+
     @property
     def addr(self):
         return int(self._bt_ptr)
@@ -143,10 +195,10 @@ class _UserMessageIterator(_MessageIterator):
             msg = next(self)
         except StopIteration:
             raise bt2.Stop
-        except:
+        except Exception:
             raise
 
-        utils._check_type(msg, bt2_message._Message)
+        utils._check_type(msg, bt2_message._MessageConst)
 
         # The reference we return will be given to the message array.
         # However, the `msg` Python object may stay alive, if the user has kept
@@ -154,16 +206,15 @@ class _UserMessageIterator(_MessageIterator):
         msg._get_ref(msg._ptr)
         return int(msg._ptr)
 
-    @property
     def _bt_can_seek_beginning_from_native(self):
         # Here, we mimic the behavior of the C API:
         #
-        # - If the iterator has a _user_can_seek_beginning attribute,
+        # - If the iterator has a _user_can_seek_beginning method,
         #   read it and use that result.
-        # - Otherwise, the presence or absence of a `_seek_beginning`
+        # - Otherwise, the presence or absence of a `_user_seek_beginning`
         #   method indicates whether the iterator can seek beginning.
         if hasattr(self, '_user_can_seek_beginning'):
-            can_seek_beginning = self._user_can_seek_beginning
+            can_seek_beginning = self._user_can_seek_beginning()
             utils._check_bool(can_seek_beginning)
             return can_seek_beginning
         else:
@@ -172,21 +223,38 @@ class _UserMessageIterator(_MessageIterator):
     def _bt_seek_beginning_from_native(self):
         self._user_seek_beginning()
 
+    def _bt_can_seek_ns_from_origin_from_native(self, ns_from_origin):
+        # Return whether the iterator can seek ns from origin using the
+        # user-implemented seek_ns_from_origin method.  We mimic the behavior
+        # of the C API:
+        #
+        # - If the iterator has a _user_can_seek_ns_from_origin method,
+        #   call it and use its return value.
+        # - Otherwise, if there is a `_user_seek_ns_from_origin` method,
+        #   we presume it's possible.
+
+        if hasattr(self, '_user_can_seek_ns_from_origin'):
+            can_seek_ns_from_origin = self._user_can_seek_ns_from_origin(ns_from_origin)
+            utils._check_bool(can_seek_ns_from_origin)
+            return can_seek_ns_from_origin
+        else:
+            return hasattr(self, '_user_seek_ns_from_origin')
+
+    def _bt_seek_ns_from_origin_from_native(self, ns_from_origin):
+        self._user_seek_ns_from_origin(ns_from_origin)
+
     def _create_input_port_message_iterator(self, input_port):
         utils._check_type(input_port, bt2_port._UserComponentInputPort)
 
-        msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_message_iterator(
+        status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_message_iterator(
             self._bt_ptr, input_port._ptr
         )
-
-        if msg_iter_ptr is None:
-            raise bt2._MemoryError('cannot create message iterator object')
+        utils._handle_func_status(status, 'cannot create message iterator object')
+        assert msg_iter_ptr is not None
 
         return _UserComponentInputPortMessageIterator(msg_iter_ptr)
 
-    def _create_event_message(
-        self, event_class, parent=None, default_clock_snapshot=None
-    ):
+    def _create_event_message(self, event_class, parent, default_clock_snapshot=None):
         utils._check_type(event_class, bt2_event_class._EventClass)
 
         if event_class.stream_class.supports_packets:
This page took 0.027041 seconds and 4 git commands to generate.