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 b102d6323a51b6b8056655b61e5ec762560099b4..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.
  *
@@ -336,6 +352,20 @@ extern int bt_ctf_field_string_append_len(
 extern struct bt_ctf_field_type *bt_ctf_field_get_type(
                struct bt_ctf_field *field);
 
+/*
+ * bt_ctf_field_copy: get a field's deep copy.
+ *
+ * Get a field's deep copy. The created field copy shares the source's
+ * associated field types.
+ *
+ * On success, the returned copy has its reference count set to 1.
+ *
+ * @param field Field instance.
+ *
+ * Returns the field copy on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_field_copy(struct bt_ctf_field *field);
+
 /*
  * bt_ctf_field_get and bt_ctf_field_put: increment and decrement the
  * field's reference count.