Mercurial > gplugin > gplugin / file revision

/*
 * Copyright (C) 2011-2020 Gary Kramlich <grim@reaperworld.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see <https://www.gnu.org/licenses/>.
 */

#if !defined(GPLUGIN_GLOBAL_HEADER_INSIDE) && !defined(GPLUGIN_COMPILATION)
#error "only <gplugin.h> may be included directly"
#endif

#ifndef GPLUGIN_MANAGER_H
#define GPLUGIN_MANAGER_H

#include <glib.h>
#include <glib-object.h>

#include <gplugin/gplugin-plugin.h>
#include <gplugin/gplugin-version.h>

G_BEGIN_DECLS

#define GPLUGIN_TYPE_MANAGER (gplugin_manager_get_type())

GPLUGIN_AVAILABLE_IN_0_32
G_DECLARE_FINAL_TYPE(GPluginManager, gplugin_manager, GPLUGIN, MANAGER, GObject)

typedef void (
	*GPluginManagerForeachFunc)(const char *id, GSList *plugins, gpointer data);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_append_path(GPluginManager *manager, const char *path);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_prepend_path(GPluginManager *manager, const char *path);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_remove_path(GPluginManager *manager, const char *path);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_remove_paths(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_add_default_paths(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_add_app_paths(
	GPluginManager *manager,
	const char *prefix,
	const char *appname);

GPLUGIN_AVAILABLE_IN_0_37
void gplugin_manager_append_paths_from_environment(
	GPluginManager *manager,
	const char *name);

GPLUGIN_AVAILABLE_IN_0_37
void gplugin_manager_prepend_paths_from_environment(
	GPluginManager *manager,
	const char *name);

GPLUGIN_AVAILABLE_IN_ALL
GList *gplugin_manager_get_paths(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_ALL
gboolean gplugin_manager_register_loader(
	GPluginManager *manager,
	GPluginLoader *loader,
	GError **error);

GPLUGIN_AVAILABLE_IN_ALL
gboolean gplugin_manager_unregister_loader(
	GPluginManager *manager,
	GPluginLoader *loader,
	GError **error);

GPLUGIN_AVAILABLE_IN_ALL
GList *gplugin_manager_get_loaders(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_refresh(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_ALL
void gplugin_manager_foreach(
	GPluginManager *manager,
	GPluginManagerForeachFunc func,
	gpointer data);

GPLUGIN_AVAILABLE_IN_ALL
GSList *gplugin_manager_find_plugins(GPluginManager *manager, const char *id);

GPLUGIN_AVAILABLE_IN_ALL
GSList *gplugin_manager_find_plugins_with_version(
	GPluginManager *manager,
	const char *id,
	const char *op,
	const char *version);

GPLUGIN_AVAILABLE_IN_ALL
GSList *gplugin_manager_find_plugins_with_state(
	GPluginManager *manager,
	GPluginPluginState state);

GPLUGIN_AVAILABLE_IN_ALL
GPluginPlugin *gplugin_manager_find_plugin(
	GPluginManager *manager,
	const char *id);

GPLUGIN_AVAILABLE_IN_0_44
GPluginPlugin *gplugin_manager_find_plugin_with_filename(
	GPluginManager *manager,
	const char *filename);

GPLUGIN_AVAILABLE_IN_ALL
GPluginPlugin *gplugin_manager_find_plugin_with_newest_version(
	GPluginManager *manager,
	const char *id);

GPLUGIN_AVAILABLE_IN_ALL
GSList *gplugin_manager_get_plugin_dependencies(
	GPluginManager *manager,
	GPluginPlugin *plugin,
	GError **error);

GPLUGIN_AVAILABLE_IN_ALL
gboolean gplugin_manager_load_plugin(
	GPluginManager *manager,
	GPluginPlugin *plugin,
	GError **error);

GPLUGIN_AVAILABLE_IN_ALL
gboolean gplugin_manager_unload_plugin(
	GPluginManager *manager,
	GPluginPlugin *plugin,
	GError **error);

GPLUGIN_AVAILABLE_IN_ALL
GList *gplugin_manager_list_plugins(GPluginManager *manager);

GPLUGIN_AVAILABLE_IN_0_33
GPluginManager *gplugin_manager_get_default(void);

G_END_DECLS

#endif /* GPLUGIN_MANAGER_H */