[babeltrace.git] / lib / component / component-class.c

/*
 * component-class.c
 *
 * Babeltrace Plugin Component Class
 *
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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/compiler.h>
#include <babeltrace/component/component-class-internal.h>
#include <babeltrace/ref.h>
#include <stdbool.h>
#include <glib.h>

static
void bt_component_class_destroy(struct bt_object *obj)
{
	struct bt_component_class *class;
	int i;

	assert(obj);
	class = container_of(obj, struct bt_component_class, base);

	/* Call destroy listeners in reverse registration order */
	for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
		struct bt_component_class_destroy_listener *listener =
			&g_array_index(class->destroy_listeners,
				struct bt_component_class_destroy_listener,
				i);

		listener->func(class, listener->data);
	}

	if (class->name) {
		g_string_free(class->name, TRUE);
	}
	if (class->description) {
		g_string_free(class->description, TRUE);
	}
	if (class->help) {
		g_string_free(class->help, TRUE);
	}
	if (class->destroy_listeners) {
		g_array_free(class->destroy_listeners, TRUE);
	}

	g_free(class);
}

static
int bt_component_class_init(struct bt_component_class *class,
		enum bt_component_class_type type, const char *name)
{
	int ret = 0;

	bt_object_init(class, bt_component_class_destroy);
	class->type = type;
	class->name = g_string_new(name);
	if (!class->name) {
		goto error;
	}

	class->description = g_string_new(NULL);
	if (!class->description) {
		goto error;
	}

	class->help = g_string_new(NULL);
	if (!class->help) {
		goto error;
	}

	class->destroy_listeners = g_array_new(FALSE, TRUE,
		sizeof(struct bt_component_class_destroy_listener));
	if (!class->destroy_listeners) {
		goto error;
	}

	goto end;

error:
	BT_PUT(class);
	ret = -1;

end:
	return ret;
}

struct bt_component_class *bt_component_class_source_create(const char *name,
		bt_component_class_notification_iterator_get_method notification_iterator_get_method,
		bt_component_class_notification_iterator_next_method notification_iterator_next_method)
{
	struct bt_component_class_source *source_class = NULL;
	int ret;

	if (!name || !notification_iterator_get_method ||
			!notification_iterator_next_method) {
		goto end;
	}

	source_class = g_new0(struct bt_component_class_source, 1);
	if (!source_class) {
		goto end;
	}

	ret = bt_component_class_init(&source_class->parent,
		BT_COMPONENT_CLASS_TYPE_SOURCE, name);
	if (ret) {
		/*
		 * If bt_component_class_init() fails, the component
		 * class is put, therefore its memory is already
		 * freed.
		 */
		source_class = NULL;
		goto end;
	}

	source_class->methods.iterator.get = notification_iterator_get_method;
	source_class->methods.iterator.next = notification_iterator_next_method;

end:
	return &source_class->parent;
}

struct bt_component_class *bt_component_class_filter_create(const char *name,
		bt_component_class_notification_iterator_get_method notification_iterator_get_method,
		bt_component_class_notification_iterator_next_method notification_iterator_next_method)
{
	struct bt_component_class_filter *filter_class = NULL;
	int ret;

	if (!name || !notification_iterator_get_method ||
			!notification_iterator_next_method) {
		goto end;
	}

	filter_class = g_new0(struct bt_component_class_filter, 1);
	if (!filter_class) {
		goto end;
	}

	ret = bt_component_class_init(&filter_class->parent,
		BT_COMPONENT_CLASS_TYPE_FILTER, name);
	if (ret) {
		/*
		 * If bt_component_class_init() fails, the component
		 * class is put, therefore its memory is already
		 * freed.
		 */
		filter_class = NULL;
		goto end;
	}

	filter_class->methods.iterator.get = notification_iterator_get_method;
	filter_class->methods.iterator.next = notification_iterator_next_method;

end:
	return &filter_class->parent;
}

struct bt_component_class *bt_component_class_sink_create(const char *name,
		bt_component_class_sink_consume_method consume_method)
{
	struct bt_component_class_sink *sink_class = NULL;
	int ret;

	if (!name || !consume_method) {
		goto end;
	}

	sink_class = g_new0(struct bt_component_class_sink, 1);
	if (!sink_class) {
		goto end;
	}

	ret = bt_component_class_init(&sink_class->parent,
		BT_COMPONENT_CLASS_TYPE_SINK, name);
	if (ret) {
		/*
		 * If bt_component_class_init() fails, the component
		 * class is put, therefore its memory is already
		 * freed.
		 */
		sink_class = NULL;
		goto end;
	}

	sink_class->methods.consume = consume_method;

end:
	return &sink_class->parent;
}

int bt_component_class_set_init_method(
		struct bt_component_class *component_class,
		bt_component_class_init_method init_method)
{
	int ret = 0;

	if (!component_class || component_class->frozen || !init_method) {
		ret = -1;
		goto end;
	}

	component_class->methods.init = init_method;

end:
	return ret;
}

int bt_component_class_set_destroy_method(
		struct bt_component_class *component_class,
		bt_component_class_destroy_method destroy_method)
{
	int ret = 0;

	if (!component_class || component_class->frozen || !destroy_method) {
		ret = -1;
		goto end;
	}

	component_class->methods.destroy = destroy_method;

end:
	return ret;
}

int bt_component_class_source_set_notification_iterator_init_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_init_method notification_iterator_init_method)
{
	struct bt_component_class_source *source_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_init_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		ret = -1;
		goto end;
	}

	source_class = container_of(component_class,
		struct bt_component_class_source, parent);
	source_class->methods.iterator.init = notification_iterator_init_method;

end:
	return ret;
}

int bt_component_class_source_set_notification_iterator_destroy_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
{
	struct bt_component_class_source *source_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_destroy_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		ret = -1;
		goto end;
	}

	source_class = container_of(component_class,
		struct bt_component_class_source, parent);
	source_class->methods.iterator.destroy =
		notification_iterator_destroy_method;

end:
	return ret;
}

int bt_component_class_source_set_notification_iterator_seek_time_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
{
	struct bt_component_class_source *source_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_seek_time_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
		ret = -1;
		goto end;
	}

	source_class = container_of(component_class,
		struct bt_component_class_source, parent);
	source_class->methods.iterator.seek_time =
		notification_iterator_seek_time_method;

end:
	return ret;
}

int bt_component_class_filter_set_notification_iterator_init_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_init_method notification_iterator_init_method)
{
	struct bt_component_class_filter *filter_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_init_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
		ret = -1;
		goto end;
	}

	filter_class = container_of(component_class,
		struct bt_component_class_filter, parent);
	filter_class->methods.iterator.init = notification_iterator_init_method;

end:
	return ret;
}

int bt_component_class_filter_set_notification_iterator_destroy_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
{
	struct bt_component_class_filter *filter_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_destroy_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
		ret = -1;
		goto end;
	}

	filter_class = container_of(component_class,
		struct bt_component_class_filter, parent);
	filter_class->methods.iterator.destroy =
		notification_iterator_destroy_method;

end:
	return ret;
}

int bt_component_class_filter_set_notification_iterator_seek_time_method(
		struct bt_component_class *component_class,
		bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
{
	struct bt_component_class_filter *filter_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!notification_iterator_seek_time_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
		ret = -1;
		goto end;
	}

	filter_class = container_of(component_class,
		struct bt_component_class_filter, parent);
	filter_class->methods.iterator.seek_time =
		notification_iterator_seek_time_method;

end:
	return ret;
}

int bt_component_class_set_description(
		struct bt_component_class *component_class,
		const char *description)
{
	int ret = 0;

	if (!component_class || component_class->frozen || !description) {
		ret = -1;
		goto end;
	}

	g_string_assign(component_class->description, description);

end:
	return ret;
}

int bt_component_class_set_help(
		struct bt_component_class *component_class,
		const char *help)
{
	int ret = 0;

	if (!component_class || component_class->frozen || !help) {
		ret = -1;
		goto end;
	}

	g_string_assign(component_class->help, help);

end:
	return ret;
}

const char *bt_component_class_get_name(
		struct bt_component_class *component_class)
{
	return component_class ? component_class->name->str : NULL;
}

enum bt_component_class_type bt_component_class_get_type(
		struct bt_component_class *component_class)
{
	return component_class ? component_class->type :
			BT_COMPONENT_CLASS_TYPE_UNKNOWN;
}

const char *bt_component_class_get_description(
		struct bt_component_class *component_class)
{
	return component_class && component_class->description &&
		component_class->description->str[0] != '\0' ?
		component_class->description->str : NULL;
}

const char *bt_component_class_get_help(
		struct bt_component_class *component_class)
{
	return component_class && component_class->help &&
		component_class->help->str[0] != '\0' ?
		component_class->help->str : NULL;
}

BT_HIDDEN
int bt_component_class_add_destroy_listener(struct bt_component_class *class,
		bt_component_class_destroy_listener_func func, void *data)
{
	int ret = 0;
	struct bt_component_class_destroy_listener listener;

	if (!class || class->frozen || !func) {
		ret = -1;
		goto end;
	}

	listener.func = func;
	listener.data = data;
	g_array_append_val(class->destroy_listeners, listener);

end:
	return ret;
}

extern int bt_component_class_sink_set_add_iterator_method(
		struct bt_component_class *component_class,
		bt_component_class_sink_add_iterator_method add_iterator_method)
{
	struct bt_component_class_sink *sink_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!add_iterator_method ||
			component_class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
		ret = -1;
		goto end;
	}

	sink_class = container_of(component_class,
		struct bt_component_class_sink, parent);
	sink_class->methods.add_iterator = add_iterator_method;

end:
	return ret;
}

extern int bt_component_class_filter_set_add_iterator_method(
		struct bt_component_class *component_class,
		bt_component_class_filter_add_iterator_method add_iterator_method)
{
	struct bt_component_class_filter *filter_class;
	int ret = 0;

	if (!component_class || component_class->frozen ||
			!add_iterator_method ||
			component_class->type !=
			BT_COMPONENT_CLASS_TYPE_FILTER) {
		ret = -1;
		goto end;
	}

	filter_class = container_of(component_class,
		struct bt_component_class_filter, parent);
	filter_class->methods.add_iterator = add_iterator_method;

end:
	return ret;
}

int bt_component_class_freeze(
		struct bt_component_class *component_class)
{
	int ret = 0;

	if (!component_class) {
		ret = -1;
		goto end;
	}

	component_class->frozen = true;

end:
	return ret;
}
Commit	Line	Data
fb2dcc52 JG	1	/*
	2	* component-class.c
	3	*
	4	* Babeltrace Plugin Component Class
33b34c43	5	*
3310b217	6	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
fb2dcc52 JG	7	*
	8	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
	29	#include <babeltrace/compiler.h>
33b34c43	30	#include <babeltrace/component/component-class-internal.h>
b8a06801	31	#include <babeltrace/ref.h>
1e4d8103	32	#include <stdbool.h>
fb2dcc52 JG	33	#include <glib.h>
	34
	35	static
b8a06801	36	void bt_component_class_destroy(struct bt_object *obj)
fb2dcc52 JG	37	{
fb2dcc52 JG	38	struct bt_component_class *class;
33b34c43	39	int i;
fb2dcc52	40
b8a06801 JG	41	assert(obj);
b8a06801 JG	42	class = container_of(obj, struct bt_component_class, base);
33b34c43 PP	43
	44	/* Call destroy listeners in reverse registration order */
	45	for (i = class->destroy_listeners->len - 1; i >= 0; i--) {
d3e4dcd8	46	struct bt_component_class_destroy_listener *listener =
33b34c43	47	&g_array_index(class->destroy_listeners,
d3e4dcd8	48	struct bt_component_class_destroy_listener,
33b34c43 PP	49	i);
	50
	51	listener->func(class, listener->data);
	52	}
	53
fb2dcc52 JG	54	if (class->name) {
	55	g_string_free(class->name, TRUE);
	56	}
7c7c0433 JG	57	if (class->description) {
	58	g_string_free(class->description, TRUE);
	59	}
5536d9a6 PP	60	if (class->help) {
	61	g_string_free(class->help, TRUE);
	62	}
33b34c43 PP	63	if (class->destroy_listeners) {
	64	g_array_free(class->destroy_listeners, TRUE);
	65	}
b8a06801	66
fb2dcc52 JG	67	g_free(class);
	68	}
	69
d3e4dcd8 PP	70	static
	71	int bt_component_class_init(struct bt_component_class *class,
	72	enum bt_component_class_type type, const char *name)
fb2dcc52	73	{
d3e4dcd8 PP	74	int ret = 0;
	75
	76	bt_object_init(class, bt_component_class_destroy);
	77	class->type = type;
	78	class->name = g_string_new(name);
	79	if (!class->name) {
	80	goto error;
	81	}
	82
	83	class->description = g_string_new(NULL);
	84	if (!class->description) {
	85	goto error;
	86	}
	87
5536d9a6 PP	88	class->help = g_string_new(NULL);
	89	if (!class->help) {
	90	goto error;
	91	}
	92
d3e4dcd8 PP	93	class->destroy_listeners = g_array_new(FALSE, TRUE,
	94	sizeof(struct bt_component_class_destroy_listener));
	95	if (!class->destroy_listeners) {
	96	goto error;
	97	}
	98
	99	goto end;
6ba0b073	100
d3e4dcd8 PP	101	error:
	102	BT_PUT(class);
	103	ret = -1;
	104
	105	end:
	106	return ret;
	107	}
	108
	109	struct bt_component_class bt_component_class_source_create(const char name,
d3eb6e8f PP	110	bt_component_class_notification_iterator_get_method notification_iterator_get_method,
d3eb6e8f PP	111	bt_component_class_notification_iterator_next_method notification_iterator_next_method)
d3e4dcd8 PP	112	{
	113	struct bt_component_class_source *source_class = NULL;
	114	int ret;
	115
d3eb6e8f PP	116	if (!name \|\| !notification_iterator_get_method \|\|
d3eb6e8f PP	117	!notification_iterator_next_method) {
6ba0b073 PP	118	goto end;
6ba0b073 PP	119	}
fb2dcc52	120
d3e4dcd8 PP	121	source_class = g_new0(struct bt_component_class_source, 1);
d3e4dcd8 PP	122	if (!source_class) {
fb2dcc52 JG	123	goto end;
	124	}
	125
d3e4dcd8 PP	126	ret = bt_component_class_init(&source_class->parent,
	127	BT_COMPONENT_CLASS_TYPE_SOURCE, name);
	128	if (ret) {
	129	/*
	130	* If bt_component_class_init() fails, the component
	131	* class is put, therefore its memory is already
	132	* freed.
	133	*/
	134	source_class = NULL;
	135	goto end;
	136	}
	137
d3eb6e8f PP	138	source_class->methods.iterator.get = notification_iterator_get_method;
d3eb6e8f PP	139	source_class->methods.iterator.next = notification_iterator_next_method;
d3e4dcd8 PP	140
	141	end:
	142	return &source_class->parent;
	143	}
	144
	145	struct bt_component_class bt_component_class_filter_create(const char name,
d3eb6e8f PP	146	bt_component_class_notification_iterator_get_method notification_iterator_get_method,
d3eb6e8f PP	147	bt_component_class_notification_iterator_next_method notification_iterator_next_method)
d3e4dcd8 PP	148	{
	149	struct bt_component_class_filter *filter_class = NULL;
	150	int ret;
	151
d3eb6e8f PP	152	if (!name \|\| !notification_iterator_get_method \|\|
d3eb6e8f PP	153	!notification_iterator_next_method) {
fb2dcc52 JG	154	goto end;
fb2dcc52 JG	155	}
6ba0b073	156
d3e4dcd8 PP	157	filter_class = g_new0(struct bt_component_class_filter, 1);
	158	if (!filter_class) {
	159	goto end;
6ba0b073 PP	160	}
6ba0b073 PP	161
d3e4dcd8 PP	162	ret = bt_component_class_init(&filter_class->parent,
	163	BT_COMPONENT_CLASS_TYPE_FILTER, name);
	164	if (ret) {
	165	/*
	166	* If bt_component_class_init() fails, the component
	167	* class is put, therefore its memory is already
	168	* freed.
	169	*/
	170	filter_class = NULL;
33b34c43 PP	171	goto end;
33b34c43 PP	172	}
d3e4dcd8	173
d3eb6e8f PP	174	filter_class->methods.iterator.get = notification_iterator_get_method;
d3eb6e8f PP	175	filter_class->methods.iterator.next = notification_iterator_next_method;
d3e4dcd8	176
fb2dcc52	177	end:
d3e4dcd8 PP	178	return &filter_class->parent;
	179	}
	180
	181	struct bt_component_class bt_component_class_sink_create(const char name,
	182	bt_component_class_sink_consume_method consume_method)
	183	{
	184	struct bt_component_class_sink *sink_class = NULL;
	185	int ret;
	186
	187	if (!name \|\| !consume_method) {
	188	goto end;
	189	}
	190
	191	sink_class = g_new0(struct bt_component_class_sink, 1);
	192	if (!sink_class) {
	193	goto end;
	194	}
	195
	196	ret = bt_component_class_init(&sink_class->parent,
	197	BT_COMPONENT_CLASS_TYPE_SINK, name);
	198	if (ret) {
	199	/*
	200	* If bt_component_class_init() fails, the component
	201	* class is put, therefore its memory is already
	202	* freed.
	203	*/
	204	sink_class = NULL;
	205	goto end;
	206	}
	207
	208	sink_class->methods.consume = consume_method;
	209
	210	end:
	211	return &sink_class->parent;
	212	}
	213
	214	int bt_component_class_set_init_method(
	215	struct bt_component_class *component_class,
	216	bt_component_class_init_method init_method)
	217	{
	218	int ret = 0;
	219
1e4d8103	220	if (!component_class \|\| component_class->frozen \|\| !init_method) {
d3e4dcd8 PP	221	ret = -1;
	222	goto end;
	223	}
	224
	225	component_class->methods.init = init_method;
	226
	227	end:
	228	return ret;
	229	}
	230
	231	int bt_component_class_set_destroy_method(
	232	struct bt_component_class *component_class,
	233	bt_component_class_destroy_method destroy_method)
	234	{
	235	int ret = 0;
	236
1e4d8103	237	if (!component_class \|\| component_class->frozen \|\| !destroy_method) {
d3e4dcd8 PP	238	ret = -1;
	239	goto end;
	240	}
	241
	242	component_class->methods.destroy = destroy_method;
	243
	244	end:
	245	return ret;
	246	}
	247
d3eb6e8f PP	248	int bt_component_class_source_set_notification_iterator_init_method(
	249	struct bt_component_class *component_class,
	250	bt_component_class_notification_iterator_init_method notification_iterator_init_method)
	251	{
	252	struct bt_component_class_source *source_class;
	253	int ret = 0;
	254
	255	if (!component_class \|\| component_class->frozen \|\|
	256	!notification_iterator_init_method \|\|
	257	component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	258	ret = -1;
	259	goto end;
	260	}
	261
	262	source_class = container_of(component_class,
	263	struct bt_component_class_source, parent);
	264	source_class->methods.iterator.init = notification_iterator_init_method;
	265
	266	end:
	267	return ret;
	268	}
	269
	270	int bt_component_class_source_set_notification_iterator_destroy_method(
	271	struct bt_component_class *component_class,
	272	bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
	273	{
	274	struct bt_component_class_source *source_class;
	275	int ret = 0;
	276
	277	if (!component_class \|\| component_class->frozen \|\|
	278	!notification_iterator_destroy_method \|\|
	279	component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	280	ret = -1;
	281	goto end;
	282	}
	283
	284	source_class = container_of(component_class,
	285	struct bt_component_class_source, parent);
	286	source_class->methods.iterator.destroy =
	287	notification_iterator_destroy_method;
	288
	289	end:
	290	return ret;
	291	}
	292
	293	int bt_component_class_source_set_notification_iterator_seek_time_method(
	294	struct bt_component_class *component_class,
	295	bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
	296	{
	297	struct bt_component_class_source *source_class;
	298	int ret = 0;
	299
	300	if (!component_class \|\| component_class->frozen \|\|
	301	!notification_iterator_seek_time_method \|\|
	302	component_class->type != BT_COMPONENT_CLASS_TYPE_SOURCE) {
	303	ret = -1;
	304	goto end;
	305	}
	306
	307	source_class = container_of(component_class,
	308	struct bt_component_class_source, parent);
	309	source_class->methods.iterator.seek_time =
	310	notification_iterator_seek_time_method;
	311
312	end:
313	return ret;
314	}
315
316	int bt_component_class_filter_set_notification_iterator_init_method(
317	struct bt_component_class *component_class,
318	bt_component_class_notification_iterator_init_method notification_iterator_init_method)
319	{
320	struct bt_component_class_filter *filter_class;
321	int ret = 0;
322
323	if (!component_class \|\| component_class->frozen \|\|
324	!notification_iterator_init_method \|\|
325	component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
326	ret = -1;
327	goto end;
328	}
329
330	filter_class = container_of(component_class,
331	struct bt_component_class_filter, parent);
332	filter_class->methods.iterator.init = notification_iterator_init_method;
333
334	end:
335	return ret;
336	}
337
338	int bt_component_class_filter_set_notification_iterator_destroy_method(
339	struct bt_component_class *component_class,
340	bt_component_class_notification_iterator_destroy_method notification_iterator_destroy_method)
341	{
342	struct bt_component_class_filter *filter_class;
343	int ret = 0;
344
345	if (!component_class \|\| component_class->frozen \|\|
346	!notification_iterator_destroy_method \|\|
347	component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
348	ret = -1;
349	goto end;
350	}
351
352	filter_class = container_of(component_class,
353	struct bt_component_class_filter, parent);
354	filter_class->methods.iterator.destroy =
355	notification_iterator_destroy_method;
356
357	end:
358	return ret;
359	}
360
361	int bt_component_class_filter_set_notification_iterator_seek_time_method(
362	struct bt_component_class *component_class,
363	bt_component_class_notification_iterator_seek_time_method notification_iterator_seek_time_method)
364	{
365	struct bt_component_class_filter *filter_class;
366	int ret = 0;
367
368	if (!component_class \|\| component_class->frozen \|\|
369	!notification_iterator_seek_time_method \|\|
370	component_class->type != BT_COMPONENT_CLASS_TYPE_FILTER) {
371	ret = -1;
372	goto end;
373	}
374
375	filter_class = container_of(component_class,
376	struct bt_component_class_filter, parent);
377	filter_class->methods.iterator.seek_time =
378	notification_iterator_seek_time_method;
379
380	end:
381	return ret;
382	}
383
384	int bt_component_class_set_description(
d3e4dcd8 PP	385	struct bt_component_class *component_class,
	386	const char *description)
	387	{
	388	int ret = 0;
	389
1e4d8103	390	if (!component_class \|\| component_class->frozen \|\| !description) {
d3e4dcd8 PP	391	ret = -1;
	392	goto end;
	393	}
	394
	395	g_string_assign(component_class->description, description);
	396
	397	end:
	398	return ret;
fb2dcc52	399	}
38b48196	400
5536d9a6 PP	401	int bt_component_class_set_help(
	402	struct bt_component_class *component_class,
	403	const char *help)
	404	{
	405	int ret = 0;
	406
	407	if (!component_class \|\| component_class->frozen \|\| !help) {
	408	ret = -1;
	409	goto end;
	410	}
	411
	412	g_string_assign(component_class->help, help);
	413
	414	end:
	415	return ret;
	416	}
	417
38b48196 JG	418	const char *bt_component_class_get_name(
	419	struct bt_component_class *component_class)
	420	{
	421	return component_class ? component_class->name->str : NULL;
	422	}
	423
d3e4dcd8	424	enum bt_component_class_type bt_component_class_get_type(
38b48196 JG	425	struct bt_component_class *component_class)
	426	{
	427	return component_class ? component_class->type :
d3e4dcd8	428	BT_COMPONENT_CLASS_TYPE_UNKNOWN;
38b48196 JG	429	}
38b48196 JG	430
33b34c43	431	const char *bt_component_class_get_description(
38b48196 JG	432	struct bt_component_class *component_class)
38b48196 JG	433	{
22e22462 PP	434	return component_class && component_class->description &&
22e22462 PP	435	component_class->description->str[0] != '\0' ?
6ba0b073	436	component_class->description->str : NULL;
38b48196	437	}
7c7c0433	438
5536d9a6 PP	439	const char *bt_component_class_get_help(
	440	struct bt_component_class *component_class)
	441	{
22e22462 PP	442	return component_class && component_class->help &&
22e22462 PP	443	component_class->help->str[0] != '\0' ?
5536d9a6 PP	444	component_class->help->str : NULL;
	445	}
	446
33b34c43 PP	447	BT_HIDDEN
	448	int bt_component_class_add_destroy_listener(struct bt_component_class *class,
	449	bt_component_class_destroy_listener_func func, void *data)
7c7c0433	450	{
33b34c43	451	int ret = 0;
d3e4dcd8	452	struct bt_component_class_destroy_listener listener;
33b34c43	453
1e4d8103	454	if (!class \|\| class->frozen \|\| !func) {
33b34c43 PP	455	ret = -1;
	456	goto end;
	457	}
	458
	459	listener.func = func;
	460	listener.data = data;
	461	g_array_append_val(class->destroy_listeners, listener);
	462
	463	end:
	464	return ret;
7c7c0433	465	}
d3e4dcd8 PP	466
	467	extern int bt_component_class_sink_set_add_iterator_method(
	468	struct bt_component_class *component_class,
	469	bt_component_class_sink_add_iterator_method add_iterator_method)
	470	{
	471	struct bt_component_class_sink *sink_class;
	472	int ret = 0;
	473
1e4d8103 PP	474	if (!component_class \|\| component_class->frozen \|\|
1e4d8103 PP	475	!add_iterator_method \|\|
d3e4dcd8 PP	476	component_class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
	477	ret = -1;
	478	goto end;
	479	}
	480
	481	sink_class = container_of(component_class,
	482	struct bt_component_class_sink, parent);
	483	sink_class->methods.add_iterator = add_iterator_method;
	484
	485	end:
	486	return ret;
	487	}
	488
	489	extern int bt_component_class_filter_set_add_iterator_method(
	490	struct bt_component_class *component_class,
	491	bt_component_class_filter_add_iterator_method add_iterator_method)
	492	{
	493	struct bt_component_class_filter *filter_class;
	494	int ret = 0;
	495
1e4d8103 PP	496	if (!component_class \|\| component_class->frozen \|\|
1e4d8103 PP	497	!add_iterator_method \|\|
d3e4dcd8 PP	498	component_class->type !=
	499	BT_COMPONENT_CLASS_TYPE_FILTER) {
	500	ret = -1;
	501	goto end;
	502	}
	503
	504	filter_class = container_of(component_class,
	505	struct bt_component_class_filter, parent);
	506	filter_class->methods.add_iterator = add_iterator_method;
	507
	508	end:
	509	return ret;
	510	}
1e4d8103 PP	511
	512	int bt_component_class_freeze(
	513	struct bt_component_class *component_class)
	514	{
	515	int ret = 0;
	516
	517	if (!component_class) {
	518	ret = -1;
	519	goto end;
	520	}
	521
	522	component_class->frozen = true;
	523
	524	end:
	525	return ret;
	526	}