Fix API : functions to access fields properties

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

diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h
index c08314f8775bbb6d0418b9f7011ccc0c30fb04f1..a08518b8a0e0aad7cc29485a283508816d4626e4 100644 (file)
--- a/include/babeltrace/ctf/events.h
+++ b/include/babeltrace/ctf/events.h
@@ -60,6 +60,16 @@ enum ctf_type_id {
        NR_CTF_TYPES,
 };
 
+/*
+ * the supported CTF string encodings
+ */
+enum ctf_string_encoding {
+       CTF_STRING_NONE = 0,
+       CTF_STRING_UTF8,
+       CTF_STRING_ASCII,
+       CTF_STRING_UNKNOWN,
+};
+
 /*
  * the structure to manipulate events
  */
@@ -123,7 +133,14 @@ struct definition *bt_ctf_get_top_level_scope(struct bt_ctf_event *event,
 const char *bt_ctf_event_name(struct bt_ctf_event *event);
 
 /*
- * bt_ctf_get_timestamp: returns the timestamp of the event or -1ULL on error
+ * bt_ctf_get_timestamp_raw: returns the timestamp of the event as written in
+ * the packet or -1ULL on error
+ */
+uint64_t bt_ctf_get_timestamp_raw(struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_get_timestamp: returns the timestamp of the event offsetted with the
+ * system clock source or -1ULL on error
  */
 uint64_t bt_ctf_get_timestamp(struct bt_ctf_event *event);
 
@@ -162,6 +179,38 @@ const char *bt_ctf_field_name(const struct definition *def);
  */
 enum ctf_type_id bt_ctf_field_type(const struct definition *def);
 
+/*
+ * bt_ctf_get_int_signedness: return the signedness of an integer
+ *
+ * return 0 if unsigned
+ * return 1 if signed
+ * return -1 on error
+ */
+int bt_ctf_get_int_signedness(const struct definition *field);
+
+/*
+ * 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);
+
+/*
+ * 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);
+
+/*
+ * bt_ctf_get_encoding: return the encoding of an int or a string.
+ * return a negative value on error
+ */
+enum ctf_string_encoding bt_ctf_get_encoding(const struct definition *field);
+
+/*
+ * 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);
+
 /*
  * Field access functions
  *