src/cli/babeltrace2-cfg-cli-args.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #ifndef CLI_BABELTRACE_CFG_CLI_ARGS_H
   8 #define CLI_BABELTRACE_CFG_CLI_ARGS_H
   9
  10 #include <stdbool.h>
  11 #include <stdlib.h>
  12 #include <stdint.h>
  13 #include <babeltrace2/value.h>
  14 #include "lib/object.h"
  15 #include "compat/compiler.h"
  16 #include <babeltrace2/graph/component.h>
  17 #include <glib.h>
  18
  19 #include "babeltrace2-cfg.h"
  20
  21 /*
  22  * Return value of functions that create a bt_config from CLI args and return
  23  * it through an out parameter.
  24  */
  25 enum bt_config_cli_args_status
  26 {
  27         /*
  28          * Config was successfully created and returned through the out
  29          * parameter.
  30          */
  31         BT_CONFIG_CLI_ARGS_STATUS_OK = 0,
  32
  33         /*
  34          * Config could not be created due to an error. The out parameter is
  35          * left unchanged.
  36          */
  37         BT_CONFIG_CLI_ARGS_STATUS_ERROR = -1,
  38
  39         /*
  40          * The arguments caused the function to print some information (help,
  41          * version, etc), not config was created.  The out parameter is left
  42          * unchanged.
  43          */
  44         BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY = 1,
  45 };
  46
  47 enum bt_config_cli_args_status bt_config_cli_args_create(int argc,
  48                 const char *argv[],
  49                 struct bt_config **cfg, bool force_omit_system_plugin_path,
  50                 bool force_omit_home_plugin_path,
  51                 const bt_value *initial_plugin_paths,
  52                 const bt_interrupter *interrupter);
  53
  54 #endif /* CLI_BABELTRACE_CFG_CLI_ARGS_H */