X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fctf%2Fevents.h;h=461cf06ccdd9c63040e45719f1a48b88154e6f29;hp=88795fa03bfdaf513f4986c9f79b91f8cc26bd24;hb=c22b9327cbc4e6d9053f998952ea71c3227b8e36;hpb=bb337d594accff803357cf30238cea7d7a8fc76e diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index 88795fa0..461cf06c 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -27,7 +27,12 @@ #include #include +#ifdef __cplusplus +extern "C" { +#endif + struct definition; +struct declaration; struct bt_ctf_event; struct bt_ctf_event_decl; struct bt_ctf_field_decl; @@ -141,10 +146,23 @@ const struct definition *bt_ctf_get_index(const struct bt_ctf_event *event, */ const char *bt_ctf_field_name(const struct definition *def); +/* + * bt_ctf_get_decl_from_def: return the declaration of a field from + * its definition or NULL on error + */ +const struct declaration *bt_ctf_get_decl_from_def(const struct definition *def); + +/* + * bt_ctf_get_decl_from_field_decl: return the declaration of a field from + * a field_decl or NULL on error + */ +const struct declaration *bt_ctf_get_decl_from_field_decl( + const struct bt_ctf_field_decl *field); + /* * bt_ctf_field_type: returns the type of a field or -1 if unknown */ -enum ctf_type_id bt_ctf_field_type(const struct definition *def); +enum ctf_type_id bt_ctf_field_type(const struct declaration *decl); /* * bt_ctf_get_int_signedness: return the signedness of an integer @@ -153,36 +171,37 @@ enum ctf_type_id bt_ctf_field_type(const struct definition *def); * return 1 if signed * return -1 on error */ -int bt_ctf_get_int_signedness(const struct definition *field); +int bt_ctf_get_int_signedness(const struct declaration *decl); /* * bt_ctf_get_int_base: return the base of an int or a negative value on error */ -int bt_ctf_get_int_base(const struct definition *field); +int bt_ctf_get_int_base(const struct declaration *decl); /* * bt_ctf_get_int_byte_order: return the byte order of an int or a negative * value on error */ -int bt_ctf_get_int_byte_order(const struct definition *field); +int bt_ctf_get_int_byte_order(const struct declaration *decl); /* * bt_ctf_get_int_len: return the size, in bits, of an int or a negative * value on error */ -ssize_t bt_ctf_get_int_len(const struct definition *field); +ssize_t bt_ctf_get_int_len(const struct declaration *decl); /* - * bt_ctf_get_encoding: return the encoding of an int or a string. + * bt_ctf_get_encoding: return the encoding of an int, a string, or of + * the integer contained in a char array or a sequence. * return a negative value on error */ -enum ctf_string_encoding bt_ctf_get_encoding(const struct definition *field); +enum ctf_string_encoding bt_ctf_get_encoding(const struct declaration *decl); /* * bt_ctf_get_array_len: return the len of an array or a negative * value on error */ -int bt_ctf_get_array_len(const struct definition *field); +int bt_ctf_get_array_len(const struct declaration *decl); /* * Field access functions @@ -193,9 +212,15 @@ int bt_ctf_get_array_len(const struct definition *field); * If the field does not exist or is not of the type requested, the value * returned is undefined. To check if an error occured, use the * bt_ctf_field_get_error() function after accessing a field. + * + * bt_ctf_get_enum_int gets the integer field of an enumeration. + * bt_ctf_get_enum_str gets the string matching the current enumeration + * value, or NULL if the current value does not match any string. */ uint64_t bt_ctf_get_uint64(const struct definition *field); int64_t bt_ctf_get_int64(const struct definition *field); +const struct definition *bt_ctf_get_enum_int(const struct definition *field); +const char *bt_ctf_get_enum_str(const struct definition *field); char *bt_ctf_get_char_array(const struct definition *field); char *bt_ctf_get_string(const struct definition *field); @@ -237,4 +262,8 @@ int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl, */ const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); +#ifdef __cplusplus +} +#endif + #endif /* _BABELTRACE_CTF_EVENTS_H */