Avoid unnecessary inclusions in public headers
[babeltrace.git] / include / babeltrace / ctf-ir / field-types.h
index 625a102e2dbaa93ed38489f1bfe94044e227cf06..69a89e5c8f00de0bd92f1be487d921d159e27214 100644 (file)
@@ -30,7 +30,9 @@
  * http://www.efficios.com/ctf
  */
 
+/* For bt_bool */
 #include <babeltrace/types.h>
+
 #include <stdint.h>
 #include <stddef.h>
 
@@ -493,10 +495,10 @@ enum bt_ctf_byte_order {
        BT_CTF_BYTE_ORDER_NATIVE = 0,
 
        /**
-       No byte order; the initial native byte order of a
+       Unspecified byte order; the initial native byte order of a
        \link ctfirtraceclass CTF IR trace class\endlink.
        */
-       BT_CTF_BYTE_ORDER_NONE,
+       BT_CTF_BYTE_ORDER_UNSPECIFIED,
 
        /// Little-endian.
        BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
@@ -759,6 +761,9 @@ enum bt_ctf_integer_base {
        /// Unknown, used for errors.
        BT_CTF_INTEGER_BASE_UNKNOWN = -1,
 
+       /// Unspecified by the tracer.
+       BT_CTF_INTEGER_BASE_UNSPECIFIED = 0,
+
        /// Binary.
        BT_CTF_INTEGER_BASE_BINARY = 2,
 
@@ -896,8 +901,9 @@ extern int bt_ctf_field_type_integer_set_is_signed(
                                preferred display base.
 @returns                       Preferred display base of the integer
                                fields described by \p int_field_type,
-                               or #BT_CTF_INTEGER_BASE_UNKNOWN on
-                               error.
+                               #BT_CTF_INTEGER_BASE_UNSPECIFIED if
+                               not specified, or
+                               #BT_CTF_INTEGER_BASE_UNKNOWN on error.
 
 @prenotnull{int_field_type}
 @preisintft{int_field_type}
@@ -924,9 +930,9 @@ extern enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base(
 @prenotnull{int_field_type}
 @preisintft{int_field_type}
 @prehot{int_field_type}
-@pre \p base is #BT_CTF_INTEGER_BASE_BINARY, #BT_CTF_INTEGER_BASE_OCTAL,
-       #BT_CTF_INTEGER_BASE_DECIMAL, or
-       #BT_CTF_INTEGER_BASE_HEXADECIMAL.
+@pre \p base is #BT_CTF_INTEGER_BASE_UNSPECIFIED,
+       #BT_CTF_INTEGER_BASE_BINARY, #BT_CTF_INTEGER_BASE_OCTAL,
+       #BT_CTF_INTEGER_BASE_DECIMAL, or #BT_CTF_INTEGER_BASE_HEXADECIMAL.
 @postrefcountsame{int_field_type}
 
 @sa bt_ctf_field_type_integer_get_base(): Returns the preferred display
This page took 0.025441 seconds and 4 git commands to generate.