lib: strictly type function return status enumerations

[babeltrace.git] / include / babeltrace2 / graph / component-class.h

diff --git a/include/babeltrace2/graph/component-class.h b/include/babeltrace2/graph/component-class.h
index f2b85930f5acb8269016b2821cb6578be782a761..d96fbb030241a0bd6f57719a80e671ee951e5737 100644 (file)
--- a/include/babeltrace2/graph/component-class.h
+++ b/include/babeltrace2/graph/component-class.h
@@ -24,33 +24,86 @@
  * SOFTWARE.
  */
 
-/* For BT_QUERY_EXECUTOR_STATUS_* */
-#include <babeltrace2/graph/query-executor-const.h>
-
 /* For bt_component_class */
 #include <babeltrace2/types.h>
 
-/* For bt_component_class_status */
-#include <babeltrace2/graph/component-class-const.h>
+/* For __BT_FUNC_STATUS_* */
+#define __BT_FUNC_STATUS_ENABLE
+#include <babeltrace2/func-status.h>
+#undef __BT_FUNC_STATUS_ENABLE
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-typedef enum bt_query_status {
-       BT_QUERY_STATUS_OK = BT_QUERY_EXECUTOR_STATUS_OK,
-       BT_QUERY_STATUS_AGAIN = BT_QUERY_EXECUTOR_STATUS_AGAIN,
-       BT_QUERY_STATUS_ERROR = BT_QUERY_EXECUTOR_STATUS_ERROR,
-       BT_QUERY_STATUS_NOMEM = BT_QUERY_EXECUTOR_STATUS_NOMEM,
-       BT_QUERY_STATUS_INVALID_OBJECT = BT_QUERY_EXECUTOR_STATUS_INVALID_OBJECT,
-       BT_QUERY_STATUS_INVALID_PARAMS = BT_QUERY_EXECUTOR_STATUS_INVALID_PARAMS,
-} bt_query_status;
+typedef enum bt_component_class_init_method_status {
+       BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_init_method_status;
 
-extern bt_component_class_status bt_component_class_set_description(
-               bt_component_class *component_class,
+typedef enum bt_component_class_port_connected_method_status {
+       BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_OK              = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_ERROR           = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_PORT_CONNECTED_METHOD_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_port_connected_method_status;
+
+typedef enum bt_component_class_query_method_status {
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_OBJECT   = __BT_FUNC_STATUS_INVALID_OBJECT,
+       BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_INVALID_PARAMS   = __BT_FUNC_STATUS_INVALID_PARAMS,
+} bt_component_class_query_method_status;
+
+typedef enum bt_component_class_message_iterator_init_method_status {
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_message_iterator_init_method_status;
+
+typedef enum bt_component_class_message_iterator_next_method_status {
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK               = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_AGAIN            = __BT_FUNC_STATUS_AGAIN,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR            = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END              = __BT_FUNC_STATUS_END,
+} bt_component_class_message_iterator_next_method_status;
+
+typedef enum bt_component_class_message_iterator_seek_beginning_method_status {
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK             = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_AGAIN          = __BT_FUNC_STATUS_AGAIN,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR          = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_message_iterator_seek_beginning_method_status;
+
+typedef enum bt_component_class_message_iterator_seek_ns_from_origin_method_status {
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK                = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN             = __BT_FUNC_STATUS_AGAIN,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_ERROR             = __BT_FUNC_STATUS_ERROR,
+       BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_message_iterator_seek_ns_from_origin_method_status;
+
+typedef enum bt_component_class_set_method_status {
+       BT_COMPONENT_CLASS_SET_METHOD_STATUS_OK =       __BT_FUNC_STATUS_OK,
+} bt_component_class_set_method_status;
+
+typedef enum bt_component_class_set_description_status {
+       BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_OK            = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_SET_DESCRIPTION_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_set_description_status;
+
+extern bt_component_class_set_description_status
+bt_component_class_set_description(bt_component_class *component_class,
                const char *description);
 
-extern bt_component_class_status bt_component_class_set_help(
+typedef enum bt_component_class_set_help_status {
+       BT_COMPONENT_CLASS_SET_HELP_STATUS_OK           = __BT_FUNC_STATUS_OK,
+       BT_COMPONENT_CLASS_SET_HELP_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
+} bt_component_class_set_help_status;
+
+extern bt_component_class_set_help_status bt_component_class_set_help(
                bt_component_class *component_class,
                const char *help);
 
@@ -58,4 +111,6 @@ extern bt_component_class_status bt_component_class_set_help(
 }
 #endif
 
+#include <babeltrace2/undef-func-status.h>
+
 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */