ir: add bt_ctf_field_variant_get_current_field()

[babeltrace.git] / include / babeltrace / ctf-ir / event-fields.h

diff --git a/include/babeltrace/ctf-ir/event-fields.h b/include/babeltrace/ctf-ir/event-fields.h
index 1d8f6439e3a761f1cf0efba5d0548ff73a90a1a8..4a55b449af3491a25cb71d263758dd2a9f78a85e 100644 (file)
--- a/include/babeltrace/ctf-ir/event-fields.h
+++ b/include/babeltrace/ctf-ir/event-fields.h
@@ -154,6 +154,22 @@ extern struct bt_ctf_field *bt_ctf_field_sequence_get_field(
 extern struct bt_ctf_field *bt_ctf_field_variant_get_field(
                struct bt_ctf_field *variant, struct bt_ctf_field *tag);
 
+/*
+ * bt_ctf_field_variant_get_current_field: get the current selected field of a
+ *     variant.
+ *
+ * Return the variant's current selected field. This function, unlike
+ * bt_ctf_field_variant_get_field(), does not create any field; it
+ * returns NULL if there's no current selected field yet.
+ *
+ * @param variant Variant field instance.
+ *
+ * Returns a field instance on success, NULL on error or when there's no
+ * current selected field.
+ */
+extern struct bt_ctf_field *bt_ctf_field_variant_get_current_field(
+               struct bt_ctf_field *variant);
+
 /*
  * bt_ctf_field_enumeration_get_container: get an enumeration field's container.
  *