ir: rename ctf_string_encoding -> bt_ctf_string_encoding

[babeltrace.git] / include / babeltrace / ctf-ir / event-types.h

diff --git a/include/babeltrace/ctf-ir/event-types.h b/include/babeltrace/ctf-ir/event-types.h
index fbef87c8e08818886a9f3607f18f35bb2445d37e..054615f121d4001bc37f281005463365321f7751 100644 (file)
--- a/include/babeltrace/ctf-ir/event-types.h
+++ b/include/babeltrace/ctf-ir/event-types.h
@@ -41,6 +41,7 @@ struct bt_ctf_event_class;
 struct bt_ctf_event;
 struct bt_ctf_field_type;
 struct bt_ctf_field;
+struct bt_ctf_field_path;
 
 enum bt_ctf_integer_base {
        BT_CTF_INTEGER_BASE_UNKNOWN = -1,
@@ -53,9 +54,9 @@ enum bt_ctf_integer_base {
 enum bt_ctf_byte_order {
        BT_CTF_BYTE_ORDER_UNKNOWN = -1,
        /*
-        * Note that native, in the context of the CTF specification, is defined as
-        * "the byte order described in the trace" and does not mean that the host's
-        * endianness will be used.
+        * Note that native, in the context of the CTF specification, is defined
+        * as "the byte order described in the trace" and does not mean that the
+        * host's endianness will be used.
         */
        BT_CTF_BYTE_ORDER_NATIVE = 0,
        BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
@@ -63,6 +64,24 @@ enum bt_ctf_byte_order {
        BT_CTF_BYTE_ORDER_NETWORK,
 };
 
+enum bt_ctf_string_encoding {
+       BT_CTF_STRING_ENCODING_NONE = CTF_STRING_NONE,
+       BT_CTF_STRING_ENCODING_UTF8 = CTF_STRING_UTF8,
+       BT_CTF_STRING_ENCODING_ASCII = CTF_STRING_ASCII,
+       BT_CTF_STRING_ENCODING_UNKNOWN = CTF_STRING_UNKNOWN,
+};
+
+enum bt_ctf_scope {
+       BT_CTF_SCOPE_UNKNOWN = -1,
+       BT_CTF_SCOPE_ENV = 0,
+       BT_CTF_SCOPE_TRACE_PACKET_HEADER = 1,
+       BT_CTF_SCOPE_STREAM_PACKET_CONTEXT = 2,
+       BT_CTF_SCOPE_STREAM_EVENT_HEADER = 3,
+       BT_CTF_SCOPE_STREAM_EVENT_CONTEXT = 4,
+       BT_CTF_SCOPE_EVENT_CONTEXT = 5,
+       BT_CTF_SCOPE_EVENT_FIELDS = 6,
+};
+
 /*
  * bt_ctf_field_type_integer_create: create an integer field type.
  *
@@ -144,9 +163,10 @@ extern int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer,
  *
  * @param integer Integer type.
  *
- * Returns the string field's encoding on success, CTF_STRING_UNKNOWN on error.
+ * Returns the string field's encoding on success,
+ * BT_CTF_STRING_ENCODING_UNKNOWN on error.
  */
-extern enum ctf_string_encoding bt_ctf_field_type_integer_get_encoding(
+extern enum bt_ctf_string_encoding bt_ctf_field_type_integer_get_encoding(
                struct bt_ctf_field_type *integer);
 
 /*
@@ -156,13 +176,14 @@ extern enum ctf_string_encoding bt_ctf_field_type_integer_get_encoding(
  * a text character.
  *
  * @param integer Integer type.
- * @param encoding Integer output encoding, defaults to CTF_STRING_ENCODING_NONE
+ * @param encoding Integer output encoding, defaults to
+ *     BT_CTF_STRING_ENCODING_NONE
  *
  * Returns 0 on success, a negative value on error.
  */
 extern int bt_ctf_field_type_integer_set_encoding(
                struct bt_ctf_field_type *integer,
-               enum ctf_string_encoding encoding);
+               enum bt_ctf_string_encoding encoding);
 
 /**
  * bt_ctf_field_type_integer_get_mapped_clock: get an integer type's mapped clock.
@@ -670,9 +691,10 @@ extern struct bt_ctf_field_type *bt_ctf_field_type_string_create(void);
  *
  * @param string_type String type.
  *
- * Returns the string's encoding on success, a CTF_STRING_UNKNOWN on error.
+ * Returns the string's encoding on success, a BT_CTF_STRING_ENCODING_UNKNOWN
+ * on error.
  */
-extern enum ctf_string_encoding bt_ctf_field_type_string_get_encoding(
+extern enum bt_ctf_string_encoding bt_ctf_field_type_string_get_encoding(
                struct bt_ctf_field_type *string_type);
 
 /*
@@ -681,14 +703,15 @@ extern enum ctf_string_encoding bt_ctf_field_type_string_get_encoding(
  * Set the string type's encoding.
  *
  * @param string_type String type.
- * @param encoding String field encoding, default CTF_STRING_ENCODING_ASCII.
- *     Valid values are CTF_STRING_ENCODING_ASCII and CTF_STRING_ENCODING_UTF8.
+ * @param encoding String field encoding, default BT_CTF_STRING_ENCODING_ASCII.
+ *     Valid values are BT_CTF_STRING_ENCODING_ASCII and
+ *     BT_CTF_STRING_ENCODING_UTF8.
  *
  * Returns 0 on success, a negative value on error.
  */
 extern int bt_ctf_field_type_string_set_encoding(
                struct bt_ctf_field_type *string_type,
-               enum ctf_string_encoding encoding);
+               enum bt_ctf_string_encoding encoding);
 
 /*
  * bt_ctf_field_type_get_alignment: get a field type's alignment.
@@ -741,6 +764,32 @@ extern enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(
 extern int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type,
                enum bt_ctf_byte_order byte_order);
 
+/*
+ * bt_ctf_field_type_variant_get_tag_field_path: get a variant's tag's field
+ *     path.
+ *
+ * Get the variant's tag's field path.
+ *
+ * @param type Field type.
+ *
+ * Returns the field path on success, NULL on error or if no field path is set.
+ */
+extern struct bt_ctf_field_path *bt_ctf_field_type_variant_get_tag_field_path(
+               struct bt_ctf_field_type *type);
+
+/*
+ * bt_ctf_field_type_sequence_get_length_field_path: get a sequence's length's
+ *     field path.
+ *
+ * Get the sequence's length's field path.
+ *
+ * @param type Field type.
+ *
+ * Returns the field path on success, NULL on error or if no field path is set.
+ */
+extern struct bt_ctf_field_path *bt_ctf_field_type_sequence_get_length_field_path(
+               struct bt_ctf_field_type *type);
+
 /*
  * bt_ctf_field_type_compare: compare two field types recursively
  *
@@ -752,8 +801,8 @@ extern int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type,
  * @param type_a Field type A.
  * @param type_b Field type B.
  *
- * Returns 0 if both field types are semantically equivalent, or a
- * negative value when they are not equivalent or on error.
+ * Returns 0 if both field types are semantically equivalent, a positive
+ * value if they are not equivalent, or a negative value on error.
  */
 extern int bt_ctf_field_type_compare(struct bt_ctf_field_type *type_a,
                struct bt_ctf_field_type *type_b);