lib: standardize variant field option function names

This patch does the following changes:

bt_field_variant_select_option_field_by_index():
    bt_field_variant_select_option_by_index()

bt_field_variant_get_selected_option_field_index():
    bt_field_variant_get_selected_option_index()

bt_field_variant_borrow_selected_class_option_const():
    bt_field_variant_borrow_selected_option_class_const()

bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const():
    bt_field_variant_with_selector_field_integer_unsigned_borrow_selected_option_class_const()

bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const():
    bt_field_variant_with_selector_field_integer_signed_borrow_selected_option_class_const()

A variant field is the instance of a variant field class. A variant
field has one or more options which are instances of the variant field
class options. A variant field option contains a field.

The `with_unsigned_integer_selector` to
`with_selector_field_integer_unsigned` and
`with_signed_integer_selector` to `with_selector_field_integer_signed`
renames match what's already in the `bt_field_class` API.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I7c8f19d06d86464b0b2131036c27adb8d909aaa3
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2571
Reviewed-by: Simon Marchi <simon.marchi@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>

diff --git a/include/babeltrace2/trace-ir/field-const.h b/include/babeltrace2/trace-ir/field-const.h
index 193cf4a44bc849c6c5a4094792788d9b6793846b..c6529df218b13df0868ffecd723945b0157fd2af 100644 (file)
--- a/include/babeltrace2/trace-ir/field-const.h
+++ b/include/babeltrace2/trace-ir/field-const.h
@@ -92,7 +92,7 @@ bt_field_array_borrow_element_field_by_index_const(
 extern const bt_field *
 bt_field_option_borrow_field_const(const bt_field *field);
 
-extern uint64_t bt_field_variant_get_selected_option_field_index(
+extern uint64_t bt_field_variant_get_selected_option_index(
                const bt_field *field);
 
 extern const bt_field *
@@ -100,15 +100,15 @@ bt_field_variant_borrow_selected_option_field_const(
                const bt_field *field);
 
 extern const bt_field_class_variant_option *
-bt_field_variant_borrow_selected_class_option_const(
+bt_field_variant_borrow_selected_option_class_const(
                const bt_field *field);
 
 extern const bt_field_class_variant_with_selector_field_integer_unsigned_option *
-bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const(
+bt_field_variant_with_selector_field_integer_unsigned_borrow_selected_option_class_const(
                const bt_field *field);
 
 extern const bt_field_class_variant_with_selector_field_integer_signed_option *
-bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const(
+bt_field_variant_with_selector_field_integer_signed_borrow_selected_option_class_const(
                const bt_field *field);
 
 #ifdef __cplusplus

diff --git a/include/babeltrace2/trace-ir/field.h b/include/babeltrace2/trace-ir/field.h
index 341ea719028f5150f7e26d6ad89a11239bbf2ed7..f95298deec5f75c748e1c130a1485fc4173a290a 100644 (file)
--- a/include/babeltrace2/trace-ir/field.h
+++ b/include/babeltrace2/trace-ir/field.h
@@ -97,12 +97,12 @@ extern void bt_field_option_set_has_field(bt_field *field, bt_bool has_field);
 
 extern bt_field *bt_field_option_borrow_field(bt_field *field);
 
-typedef enum bt_field_variant_select_option_field_by_index_status {
-       BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK          = __BT_FUNC_STATUS_OK,
-} bt_field_variant_select_option_field_by_index_status;
+typedef enum bt_field_variant_select_option_by_index_status {
+       BT_FIELD_VARIANT_SELECT_OPTION_STATUS_OK                = __BT_FUNC_STATUS_OK,
+} bt_field_variant_select_option_by_index_status;
 
-extern bt_field_variant_select_option_field_by_index_status
-bt_field_variant_select_option_field_by_index(
+extern bt_field_variant_select_option_by_index_status
+bt_field_variant_select_option_by_index(
                bt_field *field, uint64_t index);
 
 extern bt_field *bt_field_variant_borrow_selected_option_field(

diff --git a/src/bindings/python/bt2/bt2/field.py b/src/bindings/python/bt2/bt2/field.py
index fe777c34d664f7a3217aceb8083c35bef9e04efc..7229318dbc6be3b85a35c53bd294d2826d3fc8b3 100644 (file)
--- a/src/bindings/python/bt2/bt2/field.py
+++ b/src/bindings/python/bt2/bt2/field.py
@@ -752,7 +752,7 @@ class _VariantFieldConst(_ContainerFieldConst, _FieldConst):
 
     @property
     def selected_option_index(self):
-        return native_bt.field_variant_get_selected_option_field_index(self._ptr)
+        return native_bt.field_variant_get_selected_option_index(self._ptr)
 
     @property
     def selected_option(self):
@@ -788,7 +788,7 @@ class _VariantField(_VariantFieldConst, _ContainerField, _Field):
         if index < 0 or index >= len(self):
             raise IndexError('{} field object index is out of range'.format(self._NAME))
 
-        native_bt.field_variant_select_option_field_by_index(self._ptr, index)
+        native_bt.field_variant_select_option_by_index(self._ptr, index)
 
     selected_option_index = property(
         fget=_VariantFieldConst.selected_option_index.fget, fset=_selected_option_index

diff --git a/src/lib/trace-ir/field.c b/src/lib/trace-ir/field.c
index 91e918dda74bce7fbf559f605b840502bb506c69..9ab11aacbbc6e8884343c8d39174200b6a8a7f27 100644 (file)
--- a/src/lib/trace-ir/field.c
+++ b/src/lib/trace-ir/field.c
@@ -1144,7 +1144,7 @@ borrow_variant_field_selected_class_option(const struct bt_field *field)
 }
 
 const struct bt_field_class_variant_option *
-bt_field_variant_borrow_selected_class_option_const(
+bt_field_variant_borrow_selected_option_class_const(
                const struct bt_field *field)
 {
        BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
@@ -1153,7 +1153,7 @@ bt_field_variant_borrow_selected_class_option_const(
 }
 
 const struct bt_field_class_variant_with_selector_field_integer_unsigned_option *
-bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const(
+bt_field_variant_with_selector_field_integer_unsigned_borrow_selected_option_class_const(
                const struct bt_field *field)
 {
        BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
@@ -1163,7 +1163,7 @@ bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_con
 }
 
 const struct bt_field_class_variant_with_selector_field_integer_signed_option *
-bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const(
+bt_field_variant_with_selector_field_integer_signed_borrow_selected_option_class_const(
                const struct bt_field *field)
 {
        BT_ASSERT_PRE_DEV_NON_NULL(field, "Field");
@@ -1172,8 +1172,8 @@ bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const
        return (const void *) borrow_variant_field_selected_class_option(field);
 }
 
-enum bt_field_variant_select_option_field_by_index_status
-bt_field_variant_select_option_field_by_index(
+enum bt_field_variant_select_option_by_index_status
+bt_field_variant_select_option_by_index(
                struct bt_field *field, uint64_t index)
 {
        struct bt_field_variant *var_field = (void *) field;
@@ -1188,7 +1188,7 @@ bt_field_variant_select_option_field_by_index(
        return BT_FUNC_STATUS_OK;
 }
 
-uint64_t bt_field_variant_get_selected_option_field_index(
+uint64_t bt_field_variant_get_selected_option_index(
                const struct bt_field *field)
 {
        const struct bt_field_variant *var_field = (const void *) field;

diff --git a/src/plugins/ctf/common/msg-iter/msg-iter.c b/src/plugins/ctf/common/msg-iter/msg-iter.c
index 2adf68f71dcd4849b5d82ec57b8ab55ec4cb79ef..fc617f3d366ccee0f8a9b8815a23b3222c432602 100644 (file)
--- a/src/plugins/ctf/common/msg-iter/msg-iter.c
+++ b/src/plugins/ctf/common/msg-iter/msg-iter.c
@@ -2423,7 +2423,7 @@ struct ctf_field_class *bfcr_borrow_variant_selected_field_class_cb(
        if (selected_option->fc->in_ir && !msg_it->dry_run) {
                bt_field *var_field = stack_top(msg_it->stack)->base;
 
-               ret = bt_field_variant_select_option_field_by_index(
+               ret = bt_field_variant_select_option_by_index(
                        var_field, option_index);
                if (ret) {
                        BT_COMP_LOGE_APPEND_CAUSE(self_comp,

diff --git a/src/plugins/ctf/fs-sink/fs-sink-stream.c b/src/plugins/ctf/fs-sink/fs-sink-stream.c
index eec834e30ee25711b2887eddade6073cab3f2ee2..93807d749a07906c5ee7cd476cad5dc614bb3cbd 100644 (file)
--- a/src/plugins/ctf/fs-sink/fs-sink-stream.c
+++ b/src/plugins/ctf/fs-sink/fs-sink-stream.c
@@ -391,7 +391,7 @@ int write_variant_field(struct fs_sink_stream *stream,
                const bt_field *field)
 {
        uint64_t opt_index =
-               bt_field_variant_get_selected_option_field_index(field);
+               bt_field_variant_get_selected_option_index(field);
        int ret;
 
        if (fc->tag_is_before) {

diff --git a/src/plugins/lttng-utils/debug-info/trace-ir-data-copy.c b/src/plugins/lttng-utils/debug-info/trace-ir-data-copy.c
index a513adcf0c26a236ff202a5354c3c7d1fabccd68..9f0f32af26170c3ff80aa7fd4cdec756bb3e67b2 100644 (file)
--- a/src/plugins/lttng-utils/debug-info/trace-ir-data-copy.c
+++ b/src/plugins/lttng-utils/debug-info/trace-ir-data-copy.c
@@ -423,18 +423,18 @@ enum debug_info_trace_ir_mapping_status copy_field_content(
                }
        } else if (bt_field_class_type_is(in_fc_type,
                        BT_FIELD_CLASS_TYPE_VARIANT)) {
-               bt_field_variant_select_option_field_by_index_status sel_opt_status;
+               bt_field_variant_select_option_by_index_status sel_opt_status;
                uint64_t in_selected_option_idx;
                const bt_field *in_option_field;
                bt_field *out_option_field;
 
                in_selected_option_idx =
-                       bt_field_variant_get_selected_option_field_index(
+                       bt_field_variant_get_selected_option_index(
                                in_field);
-               sel_opt_status = bt_field_variant_select_option_field_by_index(out_field,
+               sel_opt_status = bt_field_variant_select_option_by_index(out_field,
                        in_selected_option_idx);
                if (sel_opt_status !=
-                               BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK) {
+                               BT_FIELD_VARIANT_SELECT_OPTION_STATUS_OK) {
                        BT_COMP_LOGE_APPEND_CAUSE(self_comp,
                                "Cannot select variant field's option field: "
                                "out-var-f-addr=%p, opt-index=%" PRId64,