X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fevent-fields.h;h=a1e1351aae2dc648b510503d20133117917fff7e;hb=4ebcc69560461edad17ab62e3a3fe733e3fdc266;hp=b102d6323a51b6b8056655b61e5ec762560099b4;hpb=f98c6554b0e1dd37e0f992f7b5e67c4431f911a6;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/event-fields.h b/include/babeltrace/ctf-ir/event-fields.h index b102d632..a1e1351a 100644 --- 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,10 +352,40 @@ 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_get_type_id: get a field's ctf_type_id. + * + * This is a helper function which avoids a call to + * bt_ctf_field_get_type(), followed by a call to + * bt_ctf_field_type_get_type_id(), followed by a call to + * bt_ctf_put(). + * + * @param field Field instance. + * + * Returns the field's ctf_type_id, CTF_TYPE_UNKNOWN on error. + */ +extern enum ctf_type_id bt_ctf_field_get_type_id(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. * + * You may also use bt_ctf_get() and bt_ctf_put() with field objects. + * * These functions ensure that the field won't be destroyed when it * is in use. The same number of get and put (plus one extra put to * release the initial reference done at creation) have to be done to