[babeltrace.git] / include / babeltrace / plugin / component-factory.h

#ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
#define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H

/*
 * Babeltrace - Component Factory Class Interface.
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <babeltrace/plugin/component.h>
#include <babeltrace/plugin/source.h>
#include <babeltrace/plugin/sink.h>
#include <babeltrace/plugin/filter.h>
#include <babeltrace/plugin/plugin-system.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Status code. Errors are always negative.
 */
enum bt_component_factory_status {
	/** General error. */
	BT_COMPONENT_FACTORY_STATUS_ERROR =		-128,

	/** Invalid plugin. */
	BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN =	-6,

	/** Invalid arguments. */
	BT_COMPONENT_FACTORY_STATUS_INVAL =		-5,

	/** Memory allocation failure. */
	BT_COMPONENT_FACTORY_STATUS_NOMEM =		-4,

	/** I/O error. */
	BT_COMPONENT_FACTORY_STATUS_IO =		-3,

	/** No such file or directory. */
	BT_COMPONENT_FACTORY_STATUS_NOENT =		-2,

	/** Operation not permitted. */
	BT_COMPONENT_FACTORY_STATUS_PERM =		-1,

	/** No error, okay. */
	BT_COMPONENT_FACTORY_STATUS_OK =		0,
};

struct bt_component_factory;

/**
 * Create a component factory.
 *
 * @returns	An instance of component factory
 */
extern
struct bt_component_factory *bt_component_factory_create(void);

/**
 * Get the list of components registered to this factory.
 */
extern
struct bt_object *bt_component_factory_get_components(
		struct bt_component_factory *factory);

/**
 * Recursively load and register Babeltrace plugins under a given path.
 *
 * Path will be traversed recursively if it is a directory, otherwise only the
 * provided file will be loaded.
 *
 * @param factory	A component factory instance
 * @param path		A path to a file or directory
 * @returns		One of #bt_component_factory_status values
 */
extern
enum bt_component_factory_status bt_component_factory_load(
		struct bt_component_factory *factory, const char *path);

extern
enum bt_component_factory_status
bt_component_factory_register_source_component_class(
		struct bt_component_factory *factory, const char *name,
		bt_component_source_init_cb init);

extern
enum bt_component_factory_status bt_component_factory_register_sink_component_class(
		struct bt_component_factory *factory, const char *name,
		bt_component_sink_init_cb init);

extern
void bt_component_factory_destroy(struct bt_component_factory *factory);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */
Commit	Line	Data
633edee0 JG	1	#ifndef BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
633edee0 JG	2	#define BABELTRACE_PLUGIN_COMPONENT_FACTORY_H
62ed7c30 JG	3
62ed7c30 JG	4	/*
633edee0	5	* Babeltrace - Component Factory Class Interface.
62ed7c30	6	*
633edee0	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
62ed7c30 JG	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*/
	27
633edee0 JG	28	#include <babeltrace/plugin/component.h>
	29	#include <babeltrace/plugin/source.h>
	30	#include <babeltrace/plugin/sink.h>
	31	#include <babeltrace/plugin/filter.h>
0d884c50	32	#include <babeltrace/plugin/plugin-system.h>
62ed7c30 JG	33
	34	#ifdef __cplusplus
	35	extern "C" {
633edee0 JG	36	#endif
633edee0 JG	37
f3e4505b JG	38	/**
	39	* Status code. Errors are always negative.
	40	*/
	41	enum bt_component_factory_status {
	42	/** General error. */
fb2dcc52 JG	43	BT_COMPONENT_FACTORY_STATUS_ERROR = -128,
	44
	45	/** Invalid plugin. */
	46	BT_COMPONENT_FACTORY_STATUS_INVAL_PLUGIN = -6,
f3e4505b JG	47
f3e4505b JG	48	/** Invalid arguments. */
fb2dcc52	49	BT_COMPONENT_FACTORY_STATUS_INVAL = -5,
f3e4505b JG	50
f3e4505b JG	51	/** Memory allocation failure. */
fb2dcc52	52	BT_COMPONENT_FACTORY_STATUS_NOMEM = -4,
f3e4505b JG	53
f3e4505b JG	54	/** I/O error. */
fb2dcc52	55	BT_COMPONENT_FACTORY_STATUS_IO = -3,
f3e4505b JG	56
f3e4505b JG	57	/** No such file or directory. */
fb2dcc52	58	BT_COMPONENT_FACTORY_STATUS_NOENT = -2,
f3e4505b JG	59
f3e4505b JG	60	/** Operation not permitted. */
fb2dcc52	61	BT_COMPONENT_FACTORY_STATUS_PERM = -1,
f3e4505b JG	62
f3e4505b JG	63	/** No error, okay. */
fb2dcc52	64	BT_COMPONENT_FACTORY_STATUS_OK = 0,
f3e4505b JG	65	};
f3e4505b JG	66
633edee0	67	struct bt_component_factory;
62ed7c30	68
f3e4505b JG	69	/**
	70	* Create a component factory.
	71	*
	72	* @returns An instance of component factory
	73	*/
	74	extern
	75	struct bt_component_factory *bt_component_factory_create(void);
	76
fb2dcc52 JG	77	/**
	78	* Get the list of components registered to this factory.
	79	*/
	80	extern
	81	struct bt_object *bt_component_factory_get_components(
	82	struct bt_component_factory *factory);
	83
f3e4505b JG	84	/**
	85	* Recursively load and register Babeltrace plugins under a given path.
	86	*
	87	* Path will be traversed recursively if it is a directory, otherwise only the
	88	* provided file will be loaded.
	89	*
	90	* @param factory A component factory instance
	91	* @param path A path to a file or directory
	92	* @returns One of #bt_component_factory_status values
	93	*/
	94	extern
	95	enum bt_component_factory_status bt_component_factory_load(
	96	struct bt_component_factory factory, const char path);
62ed7c30	97
f3e4505b JG	98	extern
	99	enum bt_component_factory_status
	100	bt_component_factory_register_source_component_class(
fb2dcc52 JG	101	struct bt_component_factory factory, const char name,
fb2dcc52 JG	102	bt_component_source_init_cb init);
62ed7c30	103
f3e4505b JG	104	extern
f3e4505b JG	105	enum bt_component_factory_status bt_component_factory_register_sink_component_class(
fb2dcc52 JG	106	struct bt_component_factory factory, const char name,
fb2dcc52 JG	107	bt_component_sink_init_cb init);
62ed7c30	108
f3e4505b	109	extern
633edee0 JG	110	void bt_component_factory_destroy(struct bt_component_factory *factory);
	111
	112	#ifdef __cplusplus
62ed7c30 JG	113	}
	114	#endif
	115
633edee0	116	#endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */