ir: rename bt_ctf_node -> bt_ctf_scope

[babeltrace.git] / include / babeltrace / ctf / events.h

diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h
index c92470cf83de30effd11a2da27928f804f501980..eb238f40401f7ba9800fe1bdf506656e8e2c793a 100644 (file)
--- a/include/babeltrace/ctf/events.h
+++ b/include/babeltrace/ctf/events.h
@@ -48,7 +48,7 @@ struct bt_ctf_field_decl;
 /*
  * the top-level scopes in CTF
  */
-enum bt_ctf_scope {
+enum ctf_scope {
        BT_TRACE_PACKET_HEADER          = 0,
        BT_STREAM_PACKET_CONTEXT        = 1,
        BT_STREAM_EVENT_HEADER          = 2,
@@ -87,7 +87,7 @@ enum ctf_string_encoding {
 /*
  * bt_ctf_get_top_level_scope: return a definition of the top-level scope
  *
- * Top-level scopes are defined in the bt_ctf_scope enum.
+ * Top-level scopes are defined in the ctf_scope enum.
  * In order to get a field or a field list, the user needs to pass a
  * scope as argument, this scope can be a top-level scope or a scope
  * relative to an arbitrary field. This function provides the mapping
@@ -95,7 +95,7 @@ enum ctf_string_encoding {
  * On error return NULL.
  */
 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event,
-               enum bt_ctf_scope scope);
+               enum ctf_scope scope);
 
 /*
  * bt_ctf_event_get_name: returns the name of the event or NULL on error
@@ -109,10 +109,12 @@ const char *bt_ctf_event_name(const struct bt_ctf_event *event);
 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *event);
 
 /*
- * bt_ctf_get_timestamp: returns the timestamp of the event offsetted
- * with the system clock source (in ns) or -1ULL on error
+ * bt_ctf_get_timestamp: get the timestamp of the event offsetted
+ * with the system clock source (in ns) in *timestamp.
+ *
+ * Return 0 on success, or -1ULL on error.
  */
-uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event);
+int bt_ctf_get_timestamp(const struct bt_ctf_event *event, int64_t *timestamp);
 
 /*
  * bt_ctf_get_field_list: obtain the list of fields for compound type
@@ -211,6 +213,12 @@ enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *decl);
  */
 int bt_ctf_get_array_len(const struct bt_declaration *decl);
 
+/*
+ * bt_ctf_get_struct_field_count: return the number of fields in a structure.
+ * Returns a negative value on error.
+ */
+uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *field);
+
 /*
  * Field access functions
  *
@@ -231,6 +239,10 @@ const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *fiel
 const char *bt_ctf_get_enum_str(const struct bt_definition *field);
 char *bt_ctf_get_char_array(const struct bt_definition *field);
 char *bt_ctf_get_string(const struct bt_definition *field);
+double bt_ctf_get_float(const struct bt_definition *field);
+const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
+const struct bt_definition *bt_ctf_get_struct_field_index(
+               const struct bt_definition *field, uint64_t i);
 
 /*
  * bt_ctf_field_get_error: returns the last error code encountered while
@@ -260,6 +272,11 @@ int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx,
  */
 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
 
+/*
+ * bt_ctf_get_decl_event_id: return the event-ID of the event or -1ULL on error
+ */
+uint64_t bt_ctf_get_decl_event_id(const struct bt_ctf_event_decl *event);
+
 /*
  * bt_ctf_get_decl_fields: get all field declarations in a scope of an event
  *
@@ -272,7 +289,7 @@ const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
  * valid as long as the trace is opened.
  */
 int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl,
-               enum bt_ctf_scope scope,
+               enum ctf_scope scope,
                struct bt_ctf_field_decl const * const **list,
                unsigned int *count);