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

/*
 * SPDX-License-Identifier: MIT
 *
 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
 */

#ifndef CLI_BABELTRACE_CFG_CLI_ARGS_H
#define CLI_BABELTRACE_CFG_CLI_ARGS_H

#include <stdbool.h>
#include <stdlib.h>
#include <stdint.h>
#include "lib/object.h"
#include "compat/compiler.h"
#include <glib.h>

#include "babeltrace2-cfg.h"

/*
 * 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);

#endif /* CLI_BABELTRACE_CFG_CLI_ARGS_H */
Commit	Line	Data
	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 "lib/object.h"
	14	#include "compat/compiler.h"
	15	#include <glib.h>
	16
	17	#include "babeltrace2-cfg.h"
	18
	19	/*
	20	* Return value of functions that create a bt_config from CLI args and return
	21	* it through an out parameter.
	22	*/
	23	enum bt_config_cli_args_status
	24	{
	25	/*
	26	* Config was successfully created and returned through the out
	27	* parameter.
	28	*/
	29	BT_CONFIG_CLI_ARGS_STATUS_OK = 0,
	30
	31	/*
	32	* Config could not be created due to an error. The out parameter is
	33	* left unchanged.
	34	*/
	35	BT_CONFIG_CLI_ARGS_STATUS_ERROR = -1,
	36
	37	/*
	38	* The arguments caused the function to print some information (help,
	39	* version, etc), not config was created. The out parameter is left
	40	* unchanged.
	41	*/
	42	BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY = 1,
	43	};
	44
	45	enum bt_config_cli_args_status bt_config_cli_args_create(int argc,
	46	const char *argv[],
	47	struct bt_config **cfg, bool force_omit_system_plugin_path,
	48	bool force_omit_home_plugin_path,
	49	const bt_value *initial_plugin_paths,
	50	const bt_interrupter *interrupter);
	51
	52	#endif /* CLI_BABELTRACE_CFG_CLI_ARGS_H */