Field API: use status

[babeltrace.git] / include / babeltrace / trace-ir / field-const.h

diff --git a/include/babeltrace/trace-ir/field-const.h b/include/babeltrace/trace-ir/field-const.h
index d868c4e7409409cbab97ec162f8354f04ca181d0..e44e8328933b447def38804dd472cf8285ef1131 100644 (file)
--- a/include/babeltrace/trace-ir/field-const.h
+++ b/include/babeltrace/trace-ir/field-const.h
@@ -2,10 +2,9 @@
 #define BABELTRACE_TRACE_IR_FIELDS_CONST_H
 
 /*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -33,60 +32,65 @@
 /* For enum bt_field_class_type */
 #include <babeltrace/trace-ir/field-class.h>
 
+/* For bt_field, bt_field_class */
+#include <babeltrace/types.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-struct bt_field;
-struct bt_field_class;
+enum bt_field_status {
+       BT_FIELD_STATUS_OK = 0,
+       BT_FIELD_STATUS_NOMEM = -12,
+};
 
-extern const struct bt_field_class *bt_field_borrow_class_const(
-               const struct bt_field *field);
+extern const bt_field_class *bt_field_borrow_class_const(
+               const bt_field *field);
 
 extern enum bt_field_class_type bt_field_get_class_type(
-               const struct bt_field *field);
+               const bt_field *field);
 
-extern int64_t bt_field_signed_integer_get_value(const struct bt_field *field);
+extern int64_t bt_field_signed_integer_get_value(const bt_field *field);
 
 extern uint64_t bt_field_unsigned_integer_get_value(
-               const struct bt_field *field);
+               const bt_field *field);
 
-extern double bt_field_real_get_value(const struct bt_field *field);
+extern double bt_field_real_get_value(const bt_field *field);
 
-extern int bt_field_unsigned_enumeration_get_mapping_labels(
-               const struct bt_field *field,
+extern enum bt_field_status bt_field_unsigned_enumeration_get_mapping_labels(
+               const bt_field *field,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
-extern int bt_field_signed_enumeration_get_mapping_labels(
-               const struct bt_field *field,
+extern enum bt_field_status bt_field_signed_enumeration_get_mapping_labels(
+               const bt_field *field,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
-extern const char *bt_field_string_get_value(const struct bt_field *field);
+extern const char *bt_field_string_get_value(const bt_field *field);
 
-extern uint64_t bt_field_string_get_length(const struct bt_field *field);
+extern uint64_t bt_field_string_get_length(const bt_field *field);
 
-extern const struct bt_field *
+extern const bt_field *
 bt_field_structure_borrow_member_field_by_index_const(
-               const struct bt_field *field, uint64_t index);
+               const bt_field *field, uint64_t index);
 
-extern const struct bt_field *
+extern const bt_field *
 bt_field_structure_borrow_member_field_by_name_const(
-               const struct bt_field *field, const char *name);
+               const bt_field *field, const char *name);
 
-extern uint64_t bt_field_array_get_length(const struct bt_field *field);
+extern uint64_t bt_field_array_get_length(const bt_field *field);
 
-extern const struct bt_field *
+extern const bt_field *
 bt_field_array_borrow_element_field_by_index_const(
-               const struct bt_field *field, uint64_t index);
+               const bt_field *field, uint64_t index);
 
 extern uint64_t bt_field_variant_get_selected_option_field_index(
-               const struct bt_field *field);
+               const bt_field *field);
 
-extern const struct bt_field *
+extern const bt_field *
 bt_field_variant_borrow_selected_option_field_const(
-               const struct bt_field *field);
+               const bt_field *field);
 
 #ifdef __cplusplus
 }