lib: add precond. check for begin <= end on pkt./ev. disc. msg. creation
[babeltrace.git] / src / bindings / python / bt2 / bt2 / message_iterator.py
index f57699f6484b523f4c0461f04363a9509ce4065f..ed5b8e58614cebf7d01f3313f50c267d84936a3e 100644 (file)
@@ -1,24 +1,6 @@
-# The MIT License (MIT)
+# SPDX-License-Identifier: MIT
 #
 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
 
 from bt2 import native_bt, object, utils
 from bt2 import message as bt2_message
@@ -37,12 +19,8 @@ class _MessageIterator(collections.abc.Iterator):
 
 
 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
-    )
+    _get_ref = staticmethod(native_bt.message_iterator_get_ref)
+    _put_ref = staticmethod(native_bt.message_iterator_put_ref)
 
     def __init__(self, ptr):
         self._current_msgs = []
@@ -66,9 +44,7 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
         return bt2_message._create_from_ptr(msg_ptr)
 
     def can_seek_beginning(self):
-        status, res = native_bt.self_component_port_input_message_iterator_can_seek_beginning(
-            self._ptr
-        )
+        (status, res) = native_bt.message_iterator_can_seek_beginning(self._ptr)
         utils._handle_func_status(
             status,
             'cannot check whether or not message iterator can seek its beginning',
@@ -80,14 +56,12 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
         self._current_msgs.clear()
         self._at = 0
 
-        status = native_bt.self_component_port_input_message_iterator_seek_beginning(
-            self._ptr
-        )
+        status = native_bt.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(
+        (status, res) = native_bt.message_iterator_can_seek_ns_from_origin(
             self._ptr, ns_from_origin
         )
         utils._handle_func_status(
@@ -103,13 +77,30 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
         self._current_msgs.clear()
         self._at = 0
 
-        status = native_bt.self_component_port_input_message_iterator_seek_ns_from_origin(
+        status = native_bt.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.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
 # is created for a given output port when an input port message iterator is
@@ -134,13 +125,14 @@ 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
@@ -204,30 +196,32 @@ class _UserMessageIterator(_MessageIterator):
         self._user_seek_beginning()
 
     def _bt_can_seek_ns_from_origin_from_native(self, ns_from_origin):
-        # Here, we mimic the behavior of the C API:
+        # 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.
-        # - Otherwise, check if we can seek to beginning (which allows us to
-        #   seek to beginning and then fast forward - aka auto-seek).
+
         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
-        elif hasattr(self, '_user_seek_ns_from_origin'):
-            return True
         else:
-            return self._bt_can_seek_beginning_from_native()
+            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):
+    def _create_message_iterator(self, input_port):
         utils._check_type(input_port, bt2_port._UserComponentInputPort)
 
-        status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_message_iterator(
+        (
+            status,
+            msg_iter_ptr,
+        ) = native_bt.bt2_message_iterator_create_from_message_iterator(
             self._bt_ptr, input_port._ptr
         )
         utils._handle_func_status(status, 'cannot create message iterator object')
@@ -386,6 +380,14 @@ class _UserMessageIterator(_MessageIterator):
 
             utils._check_uint64(beg_clock_snapshot)
             utils._check_uint64(end_clock_snapshot)
+
+            if beg_clock_snapshot > end_clock_snapshot:
+                raise ValueError(
+                    'beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})'.format(
+                        beg_clock_snapshot, end_clock_snapshot
+                    )
+                )
+
             ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots(
                 self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
             )
@@ -423,6 +425,14 @@ class _UserMessageIterator(_MessageIterator):
 
             utils._check_uint64(beg_clock_snapshot)
             utils._check_uint64(end_clock_snapshot)
+
+            if beg_clock_snapshot > end_clock_snapshot:
+                raise ValueError(
+                    'beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})'.format(
+                        beg_clock_snapshot, end_clock_snapshot
+                    )
+                )
+
             ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots(
                 self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
             )
This page took 0.025634 seconds and 4 git commands to generate.