lib: add internal object pool API and use it; adapt plugins/tests
[babeltrace.git] / include / babeltrace / ctf-ir / field-path.h
index e53b50f13c156ce09bbefb7108999949fd5831b6..d5e5e43dc9e12e9ced15fd5472282b9b63142637 100644 (file)
@@ -1,5 +1,5 @@
-#ifndef BABELTRACE_CTF_IR_FIELD_PATH
-#define BABELTRACE_CTF_IR_FIELD_PATH
+#ifndef BABELTRACE_CTF_IR_FIELD_PATH_H
+#define BABELTRACE_CTF_IR_FIELD_PATH_H
 
 /*
  * BabelTrace - CTF IR: Field path
  */
 
 #include <stdint.h>
-#include <babeltrace/ctf-ir/field-types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+struct bt_field_type;
+
 /**
 @defgroup ctfirfieldpath CTF IR field path
 @ingroup ctfir
@@ -56,8 +57,8 @@ As a reminder, here's the structure of a CTF packet:
 
 Sequence and variant \link ctfirfieldtypes CTF IR field types\endlink
 can return a field path to resp. their length field and tag field
-with resp. bt_ctf_field_type_sequence_get_length_field_path() and
-bt_ctf_field_type_variant_get_tag_field_path().
+with resp. bt_field_type_sequence_get_length_field_path() and
+bt_field_type_variant_get_tag_field_path().
 
 A field path has a <em>root scope</em> which indicates from which of the
 six CTF scopes to begin. It also has a list of structure field <em>path
@@ -79,24 +80,24 @@ management of Babeltrace objects.
 */
 
 /**
-@struct bt_ctf_field_path
+@struct bt_field_path
 @brief A CTF IR field path.
 @sa ctfirfieldpath
 */
-struct bt_ctf_field_path;
+struct bt_field_path;
 
 /**
 @brief Returns the root scope of the CTF IR field path \p field_path.
 
 @param[in] field_path  Field path of which to get the root scope.
 @returns               Root scope of \p field_path, or
-                       #BT_CTF_SCOPE_UNKNOWN on error.
+                       #BT_SCOPE_UNKNOWN on error.
 
 @prenotnull{field_path}
 @postrefcountsame{field_path}
 */
-extern enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
-               const struct bt_ctf_field_path *field_path);
+extern enum bt_scope bt_field_path_get_root_scope(
+               const struct bt_field_path *field_path);
 
 /**
 @brief Returns the number of path indexes contained in the CTF IR field
@@ -110,8 +111,8 @@ extern enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
 @prenotnull{field_path}
 @postrefcountsame{field_path}
 */
-extern int64_t bt_ctf_field_path_get_index_count(
-               const struct bt_ctf_field_path *field_path);
+extern int64_t bt_field_path_get_index_count(
+               const struct bt_field_path *field_path);
 
 /**
 @brief Returns the path index contained in the CTF IR field
@@ -126,12 +127,11 @@ extern int64_t bt_ctf_field_path_get_index_count(
 @prenotnull{field_path}
 @pre \p index is lesser than the number of path indexes contained in the
        field path \p field_path (see
-       bt_ctf_field_path_get_index_count()).
+       bt_field_path_get_index_count()).
 @postrefcountsame{field_path}
 */
-extern int bt_ctf_field_path_get_index(
-               const struct bt_ctf_field_path *field_path,
-               int index);
+extern int bt_field_path_get_index(
+               const struct bt_field_path *field_path, uint64_t index);
 
 /** @} */
 
@@ -139,4 +139,4 @@ extern int bt_ctf_field_path_get_index(
 }
 #endif
 
-#endif /* BABELTRACE_CTF_IR_FIELD_PATH */
+#endif /* BABELTRACE_CTF_IR_FIELD_PATH_H */
This page took 0.025054 seconds and 4 git commands to generate.