lib: add precond. check for begin <= end on pkt./ev. disc. msg. creation

[babeltrace.git] / src / bindings / python / bt2 / bt2 / message_iterator.py

diff --git a/src/bindings/python/bt2/bt2/message_iterator.py b/src/bindings/python/bt2/bt2/message_iterator.py
index 8f3aac92ef6c8e045cefb62c13229706558d8825..ed5b8e58614cebf7d01f3313f50c267d84936a3e 100644 (file)
--- a/src/bindings/python/bt2/bt2/message_iterator.py
+++ b/src/bindings/python/bt2/bt2/message_iterator.py
@@ -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,12 +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',
@@ -83,17 +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(
@@ -109,7 +77,7 @@ 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(
@@ -118,9 +86,7 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
 
     @property
     def can_seek_forward(self):
-        return native_bt.self_component_port_input_message_iterator_can_seek_forward(
-            self._ptr
-        )
+        return native_bt.message_iterator_can_seek_forward(self._ptr)
 
 
 class _MessageIteratorConfiguration:
@@ -249,13 +215,13 @@ class _UserMessageIterator(_MessageIterator):
     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(
+        ) = 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')
@@ -414,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
             )
@@ -451,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
             )