lib: make message iterator creation functions return a status

[babeltrace.git] / include / babeltrace2 / value-const.h

diff --git a/include/babeltrace2/value-const.h b/include/babeltrace2/value-const.h
index 5142abfde233b72809c08569e5b13c83c68d0a6c..f9a1d3d093cad57badc49151f8a4fc083e889f4b 100644 (file)
--- a/include/babeltrace2/value-const.h
+++ b/include/babeltrace2/value-const.h
@@ -1,8 +1,8 @@
-#ifndef BABELTRACE_VALUES_CONST_H
-#define BABELTRACE_VALUES_CONST_H
+#ifndef BABELTRACE2_VALUE_CONST_H
+#define BABELTRACE2_VALUE_CONST_H
 
 /*
- * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
+ * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -23,27 +23,19 @@
  * SOFTWARE.
  */
 
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
+#endif
+
 #include <stdint.h>
 #include <stddef.h>
 
-/* For bt_bool, bt_value */
 #include <babeltrace2/types.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef enum bt_value_status {
-       /// Operation canceled.
-       BT_VALUE_STATUS_CANCELED        = 125,
-
-       /// Cannot allocate memory.
-       BT_VALUE_STATUS_NOMEM           = -12,
-
-       /// Okay, no error.
-       BT_VALUE_STATUS_OK              = 0,
-} bt_value_status;
-
 typedef enum bt_value_type {
        /// Null value object.
        BT_VALUE_TYPE_NULL              = 0,
@@ -120,7 +112,12 @@ bt_bool bt_value_is_map(const bt_value *object)
        return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
 }
 
-extern bt_value_status bt_value_copy(const bt_value *object,
+typedef enum bt_value_copy_status {
+       BT_VALUE_COPY_STATUS_MEMORY_ERROR       = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_VALUE_COPY_STATUS_OK                 = __BT_FUNC_STATUS_OK,
+} bt_value_copy_status;
+
+extern bt_value_copy_status bt_value_copy(const bt_value *object,
                bt_value **copy);
 
 extern bt_bool bt_value_compare(const bt_value *object_a,
@@ -128,20 +125,20 @@ extern bt_bool bt_value_compare(const bt_value *object_a,
 
 extern bt_bool bt_value_bool_get(const bt_value *bool_obj);
 
-extern uint64_t bt_value_unsigned_integer_get(const bt_value *integer_obj);
+extern uint64_t bt_value_integer_unsigned_get(const bt_value *integer_obj);
 
-extern int64_t bt_value_signed_integer_get(const bt_value *integer_obj);
+extern int64_t bt_value_integer_signed_get(const bt_value *integer_obj);
 
 extern double bt_value_real_get(const bt_value *real_obj);
 
 extern const char *bt_value_string_get(const bt_value *string_obj);
 
-extern uint64_t bt_value_array_get_size(const bt_value *array_obj);
+extern uint64_t bt_value_array_get_length(const bt_value *array_obj);
 
 static inline
 bt_bool bt_value_array_is_empty(const bt_value *array_obj)
 {
-       return bt_value_array_get_size(array_obj) == 0;
+       return bt_value_array_get_length(array_obj) == 0;
 }
 
 extern const bt_value *bt_value_array_borrow_element_by_index_const(
@@ -161,14 +158,25 @@ extern const bt_value *bt_value_map_borrow_entry_value_const(
 typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key,
                const bt_value *object, void *data);
 
-extern bt_value_status bt_value_map_foreach_entry_const(
+typedef enum bt_value_map_foreach_entry_const_status {
+       BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK              = __BT_FUNC_STATUS_OK,
+       BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_INTERRUPTED     = __BT_FUNC_STATUS_INTERRUPTED,
+} bt_value_map_foreach_entry_const_status;
+
+extern bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const(
                const bt_value *map_obj,
                bt_value_map_foreach_entry_const_func func, void *data);
 
 extern bt_bool bt_value_map_has_entry(const bt_value *map_obj,
                const char *key);
 
-extern bt_value_status bt_value_map_extend(
+typedef enum bt_value_map_extend_status {
+       BT_VALUE_MAP_EXTEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_VALUE_MAP_EXTEND_STATUS_OK           = __BT_FUNC_STATUS_OK,
+} bt_value_map_extend_status;
+
+extern bt_value_map_extend_status bt_value_map_extend(
                const bt_value *base_map_obj,
                const bt_value *extension_map_obj,
                bt_value **extended_map_obj);
@@ -194,4 +202,4 @@ extern void bt_value_put_ref(const bt_value *value);
 }
 #endif
 
-#endif /* BABELTRACE_VALUES_CONST_H */
+#endif /* BABELTRACE2_VALUE_CONST_H */