X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf-ir%2Fevent-fields.h;h=898fee981e353c730b8883fa0303552b6ca9288f;hb=8f3553be160b8643ba18c1bfda89d8ef6311ee11;hp=332d7d473ef05edcbd3e696b1a723c2edc4cc9ec;hpb=152e73317ae62636f7cc75544a11c564ab3ef836;p=babeltrace.git diff --git a/include/babeltrace/ctf-ir/event-fields.h b/include/babeltrace/ctf-ir/event-fields.h index 332d7d47..898fee98 100644 --- a/include/babeltrace/ctf-ir/event-fields.h +++ b/include/babeltrace/ctf-ir/event-fields.h @@ -4,7 +4,7 @@ /* * BabelTrace - CTF IR: Event Fields * - * Copyright 2013 EfficiOS Inc. + * Copyright 2013, 2014 Jérémie Galarneau * * Author: Jérémie Galarneau * @@ -82,7 +82,7 @@ extern struct bt_ctf_field *bt_ctf_field_structure_get_field( * Returns a field instance on success, NULL on error. */ extern struct bt_ctf_field *bt_ctf_field_structure_get_field_by_index( - struct bt_ctf_field *structure, size_t index); + struct bt_ctf_field *structure, int index); /* * bt_ctf_field_array_get_field: get an array's field at position "index". @@ -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. * @@ -288,6 +304,44 @@ extern const char *bt_ctf_field_string_get_value( extern int bt_ctf_field_string_set_value(struct bt_ctf_field *string_field, const char *value); +/* + * bt_ctf_field_string_append: append a string to a string field's + * current value. + * + * Append a string to the current value of a string field. If the string + * field was never set using bt_ctf_field_string_set_value(), it is + * first set to an empty string, and then the concatenation happens. + * + * @param string_field String field instance. + * @param value String to append to the current string field's value. + * + * Returns 0 on success, a negative value on error. + */ +extern int bt_ctf_field_string_append(struct bt_ctf_field *string_field, + const char *value); + +/* + * bt_ctf_field_string_append_len: append a string of a given length to + * a string field's current value. + * + * Append a string of a given length to the current value of a string + * field. If the string field was never set using + * bt_ctf_field_string_set_value(), it is first set to an empty string, + * and then the concatenation happens. + * + * If a null byte is encountered before the given length, only the + * substring before the first null byte is appended. + * + * @param string_field String field instance. + * @param value String to append to the current string field's value. + * @param length Length of string value to append. + * + * Returns 0 on success, a negative value on error. + */ +extern int bt_ctf_field_string_append_len( + struct bt_ctf_field *string_field, const char *value, + unsigned int length); + /* * bt_ctf_field_get_type: get a field's type * @@ -298,10 +352,120 @@ extern int bt_ctf_field_string_set_value(struct bt_ctf_field *string_field, 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_is_integer: returns whether or not a given field + * is an integer type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is an integer type, 0 otherwise. + */ +extern int bt_ctf_field_is_integer(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_floating_point: returns whether or not a given field + * is a floating point number type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is a floating point number type, 0 otherwise. + */ +extern int bt_ctf_field_is_floating_point(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_enumeration: returns whether or not a given field + * is an enumeration type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is an enumeration type, 0 otherwise. + */ +extern int bt_ctf_field_is_enumeration(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_string: returns whether or not a given field + * is a string type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is a string type, 0 otherwise. + */ +extern int bt_ctf_field_is_string(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_structure: returns whether or not a given field + * is a structure type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is a structure type, 0 otherwise. + */ +extern int bt_ctf_field_is_structure(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_array: returns whether or not a given field + * is an array type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is an array type, 0 otherwise. + */ +extern int bt_ctf_field_is_array(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_sequence: returns whether or not a given field + * is a sequence type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is a sequence type, 0 otherwise. + */ +extern int bt_ctf_field_is_sequence(struct bt_ctf_field *field); + +/* + * bt_ctf_field_is_variant: returns whether or not a given field + * is a variant type. + * + * @param field Field instance. + * + * Returns 1 if the field instance is a variant type, 0 otherwise. + */ +extern int bt_ctf_field_is_variant(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