[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 arguments. */
	/* -22 for compatibility with -EINVAL */
	BT_COMPONENT_FACTORY_STATUS_INVAL =	-22,

	/** Memory allocation failure. */
	/* -12 for compatibility with -ENOMEM */
	BT_COMPONENT_FACTORY_STATUS_NOMEM =	-12,

	/** I/O error. */
	/* -5 for compatibility with -EIO */
	BT_COMPONENT_FACTORY_STATUS_IO =	-5,

	/** No such file or directory. */
	/* -2 for compatibility with -ENOENT */
	BT_COMPONENT_FACTORY_STATUS_NOENT =	-2,

	/** Operation not permitted. */
	/* -1 for compatibility with -EPERM */
	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);

/**
 * 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. */
	43	BT_COMPONENT_FACTORY_STATUS_ERROR = -128,
	44
	45	/** Invalid arguments. */
	46	/* -22 for compatibility with -EINVAL */
	47	BT_COMPONENT_FACTORY_STATUS_INVAL = -22,
	48
	49	/** Memory allocation failure. */
	50	/* -12 for compatibility with -ENOMEM */
	51	BT_COMPONENT_FACTORY_STATUS_NOMEM = -12,
	52
	53	/** I/O error. */
	54	/* -5 for compatibility with -EIO */
	55	BT_COMPONENT_FACTORY_STATUS_IO = -5,
	56
	57	/** No such file or directory. */
	58	/* -2 for compatibility with -ENOENT */
	59	BT_COMPONENT_FACTORY_STATUS_NOENT = -2,
	60
	61	/** Operation not permitted. */
	62	/* -1 for compatibility with -EPERM */
	63	BT_COMPONENT_FACTORY_STATUS_PERM = -1,
	64
	65	/** No error, okay. */
	66	BT_COMPONENT_FACTORY_STATUS_OK = 0,
	67	};
	68
633edee0	69	struct bt_component_factory;
62ed7c30	70
f3e4505b JG	71	/**
	72	* Create a component factory.
	73	*
	74	* @returns An instance of component factory
	75	*/
	76	extern
	77	struct bt_component_factory *bt_component_factory_create(void);
	78
	79	/**
	80	* Recursively load and register Babeltrace plugins under a given path.
	81	*
	82	* Path will be traversed recursively if it is a directory, otherwise only the
	83	* provided file will be loaded.
	84	*
	85	* @param factory A component factory instance
	86	* @param path A path to a file or directory
	87	* @returns One of #bt_component_factory_status values
	88	*/
	89	extern
	90	enum bt_component_factory_status bt_component_factory_load(
	91	struct bt_component_factory factory, const char path);
62ed7c30	92
f3e4505b JG	93	extern
	94	enum bt_component_factory_status
	95	bt_component_factory_register_source_component_class(
633edee0	96	struct bt_component_factory factory, const char name,
8738a040	97	bt_component_source_init_cb init);
62ed7c30	98
f3e4505b JG	99	extern
f3e4505b JG	100	enum bt_component_factory_status bt_component_factory_register_sink_component_class(
633edee0	101	struct bt_component_factory factory, const char name,
8738a040	102	bt_component_sink_init_cb init);
62ed7c30	103
f3e4505b	104	extern
633edee0 JG	105	void bt_component_factory_destroy(struct bt_component_factory *factory);
	106
	107	#ifdef __cplusplus
62ed7c30 JG	108	}
	109	#endif
	110
633edee0	111	#endif /* BABELTRACE_PLUGIN_COMPONENT_FACTORY_H */