cli: make config cli args functions return a status enum

[babeltrace.git] / src / cli / babeltrace2-cfg-cli-args.h

diff --git a/src/cli/babeltrace2-cfg-cli-args.h b/src/cli/babeltrace2-cfg-cli-args.h
index 74ed4768bdf2f59de5095efbede65ccd60c2b8e8..92f499950a7b72d4919275b6cd92bab2af4ad340 100644 (file)
--- a/src/cli/babeltrace2-cfg-cli-args.h
+++ b/src/cli/babeltrace2-cfg-cli-args.h
@@ -18,8 +18,35 @@
 
 #include "babeltrace2-cfg.h"
 
-struct bt_config *bt_config_cli_args_create(int argc, const char *argv[],
-               int *retcode, bool force_omit_system_plugin_path,
+/*
+ * Return value of functions that create a bt_config from CLI args and return
+ * it through an out parameter.
+ */
+enum bt_config_cli_args_status
+{
+       /*
+        * Config was successfully created and returned through the out
+        * parameter.
+        */
+       BT_CONFIG_CLI_ARGS_STATUS_OK = 0,
+
+       /*
+        * Config could not be created due to an error. The out parameter is
+        * left unchanged.
+        */
+       BT_CONFIG_CLI_ARGS_STATUS_ERROR = -1,
+
+       /*
+        * The arguments caused the function to print some information (help,
+        * version, etc), not config was created.  The out parameter is left
+        * unchanged.
+        */
+       BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY = 1,
+};
+
+enum bt_config_cli_args_status bt_config_cli_args_create(int argc,
+               const char *argv[],
+               struct bt_config **cfg, bool force_omit_system_plugin_path,
                bool force_omit_home_plugin_path,
                const bt_value *initial_plugin_paths,
                const bt_interrupter *interrupter);