lib: rename `bt_*_labels_by_value` -> `bt_*_labels_for_value`

It just feels more right this way.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I6cbe9542417ba4b9688d1920189591727597d3ba
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1665
Tested-by: jenkins <jenkins@lttng.org>

diff --git a/include/babeltrace2/trace-ir/field-class-const.h b/include/babeltrace2/trace-ir/field-class-const.h
index c2ab2ebe2e30da62a0dc92e9d3a9cbcc958d2a16..a316ca269e20586629959bd61e6479a0e0774f15 100644 (file)
--- a/include/babeltrace2/trace-ir/field-class-const.h
+++ b/include/babeltrace2/trace-ir/field-class-const.h
@@ -124,19 +124,19 @@ bt_field_class_signed_enumeration_mapping_get_range_by_index(
                const bt_field_class_signed_enumeration_mapping *mapping,
                uint64_t index, int64_t *lower, int64_t *upper);
 
-typedef enum bt_field_class_enumeration_get_mapping_labels_by_value_status {
+typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
        BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
        BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK                = __BT_FUNC_STATUS_OK,
-} bt_field_class_enumeration_get_mapping_labels_by_value_status;
+} bt_field_class_enumeration_get_mapping_labels_for_value_status;
 
-extern bt_field_class_enumeration_get_mapping_labels_by_value_status
-bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
+extern bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
                const bt_field_class *field_class, uint64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
-extern bt_field_class_enumeration_get_mapping_labels_by_value_status
-bt_field_class_signed_enumeration_get_mapping_labels_by_value(
+extern bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_signed_enumeration_get_mapping_labels_for_value(
                const bt_field_class *field_class, int64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);

diff --git a/src/bindings/python/bt2/bt2/field_class.py b/src/bindings/python/bt2/bt2/field_class.py
index 7ea00c213383f2e4d4628ce75f990c6cf16f5b8e..16d46922b59f89966f427bb398f6c39b3f70929d 100644 (file)
--- a/src/bindings/python/bt2/bt2/field_class.py
+++ b/src/bindings/python/bt2/bt2/field_class.py
@@ -177,8 +177,8 @@ class _EnumerationFieldClass(_IntegerFieldClass, collections.abc.Mapping):
         utils._handle_func_status(status,
                                   "cannot add mapping to enumeration field class object")
 
-    def labels_by_value(self, value):
-        status, labels = self._get_mapping_labels_by_value(self._ptr, value)
+    def labels_for_value(self, value):
+        status, labels = self._get_mapping_labels_for_value(self._ptr, value)
         utils._handle_func_status(status, "cannot get mapping labels")
         return labels
 
@@ -220,9 +220,9 @@ class _UnsignedEnumerationFieldClass(_EnumerationFieldClass, _UnsignedIntegerFie
         return native_bt.field_class_unsigned_enumeration_map_range(enum_ptr, label, lower, upper)
 
     @staticmethod
-    def _get_mapping_labels_by_value(enum_ptr, value):
+    def _get_mapping_labels_for_value(enum_ptr, value):
         utils._check_uint64(value)
-        return native_bt.field_class_unsigned_enumeration_get_mapping_labels_by_value(enum_ptr, value)
+        return native_bt.field_class_unsigned_enumeration_get_mapping_labels_for_value(enum_ptr, value)
 
 
 class _SignedEnumerationFieldClass(_EnumerationFieldClass, _SignedIntegerFieldClass):
@@ -241,9 +241,9 @@ class _SignedEnumerationFieldClass(_EnumerationFieldClass, _SignedIntegerFieldCl
         return native_bt.field_class_signed_enumeration_map_range(enum_ptr, label, lower, upper)
 
     @staticmethod
-    def _get_mapping_labels_by_value(enum_ptr, value):
+    def _get_mapping_labels_for_value(enum_ptr, value):
         utils._check_int64(value)
-        return native_bt.field_class_signed_enumeration_get_mapping_labels_by_value(enum_ptr, value)
+        return native_bt.field_class_signed_enumeration_get_mapping_labels_for_value(enum_ptr, value)
 
 
 class _StringFieldClass(_FieldClass):

diff --git a/src/lib/trace-ir/field-class.c b/src/lib/trace-ir/field-class.c
index 4c3de506e875e45b97e8f81cf35230d1f930f34a..c413f7e511232d81138fb7cfa1303516f503e739 100644 (file)
--- a/src/lib/trace-ir/field-class.c
+++ b/src/lib/trace-ir/field-class.c
@@ -368,8 +368,8 @@ void bt_field_class_signed_enumeration_mapping_get_range_by_index(
                (uint64_t *) lower, (uint64_t *) upper);
 }
 
-enum bt_field_class_enumeration_get_mapping_labels_by_value_status
-bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
+enum bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
                const struct bt_field_class *fc, uint64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count)
@@ -408,8 +408,8 @@ bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
        return BT_FUNC_STATUS_OK;
 }
 
-enum bt_field_class_enumeration_get_mapping_labels_by_value_status
-bt_field_class_signed_enumeration_get_mapping_labels_by_value(
+enum bt_field_class_enumeration_get_mapping_labels_for_value_status
+bt_field_class_signed_enumeration_get_mapping_labels_for_value(
                const struct bt_field_class *fc, int64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count)

diff --git a/src/lib/trace-ir/field-class.h b/src/lib/trace-ir/field-class.h
index 6947c937513eadb37a217896eac22b6d54fb1999..52582d38e2db2b77949ab1ad0ca2324d043c3984 100644 (file)
--- a/src/lib/trace-ir/field-class.h
+++ b/src/lib/trace-ir/field-class.h
@@ -142,9 +142,9 @@ struct bt_field_class_enumeration {
        /*
         * This is an array of `const char *` which acts as a temporary
         * (potentially growing) buffer for
-        * bt_field_class_unsigned_enumeration_get_mapping_labels_by_value()
+        * bt_field_class_unsigned_enumeration_get_mapping_labels_for_value()
         * and
-        * bt_field_class_signed_enumeration_get_mapping_labels_by_value().
+        * bt_field_class_signed_enumeration_get_mapping_labels_for_value().
         *
         * The actual strings are owned by the mappings above.
         */

diff --git a/src/lib/trace-ir/field.c b/src/lib/trace-ir/field.c
index d3db8d7221fd2a3a2e257925f5eeb1516182bee5..805de0f8f63779f20c383a4115d7c07651a586b9 100644 (file)
--- a/src/lib/trace-ir/field.c
+++ b/src/lib/trace-ir/field.c
@@ -583,7 +583,7 @@ bt_field_unsigned_enumeration_get_mapping_labels(
        BT_ASSERT_PRE_FIELD_HAS_CLASS_TYPE(field,
                BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, "Field");
        return (int)
-               bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
+               bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
                        field->class, int_field->value.u, label_array, count);
 }
 
@@ -602,7 +602,7 @@ bt_field_signed_enumeration_get_mapping_labels(
        BT_ASSERT_PRE_FIELD_HAS_CLASS_TYPE(field,
                BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, "Field");
        return (int)
-               bt_field_class_signed_enumeration_get_mapping_labels_by_value(
+               bt_field_class_signed_enumeration_get_mapping_labels_for_value(
                        field->class, int_field->value.i, label_array, count);
 }
 

diff --git a/tests/bindings/python/bt2/test_field_class.py b/tests/bindings/python/bt2/test_field_class.py
index bb73da48c03c41646faacdca9daa3f1ea4a1e766..afdf9b63088ac4156951ef3ef68e877803eeb317 100644 (file)
--- a/tests/bindings/python/bt2/test_field_class.py
+++ b/tests/bindings/python/bt2/test_field_class.py
@@ -217,7 +217,7 @@ class EnumerationFieldClassTestCase(_TestIntegerFieldClassProps):
         self._fc.map_range('f', 0)
         self._fc.map_range('g', 14)
 
-        labels = self._fc.labels_by_value(14)
+        labels = self._fc.labels_for_value(14)
 
         expected_labels = ['c', 'd', 'e', 'g']