gplugin/gplugin

Implement enable switch in GTK4 viewer

2021-12-16, Elliott Sales de Andrade
f03eee6f9596
Implement enable switch in GTK4 viewer

This adds a `state-set` signal on the plugin row, which merely re-broadcasts the signal from the switch. This enables the view to watch for the signal and pass along the desired state to the manager.

The plugin row sets the display of the enable switch whenever the plugin state refreshes. I'm not entirely sure if all states are displayed in the way we want.

Testing Done:
Start viewer and see that auto-loaded plugins are actually enabled, and that others can be enabled/disabled.

Reviewed at https://reviews.imfreedom.org/r/1193/
/*
* Copyright (C) 2011-2021 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/>.
*/
#include <stdio.h>
#include <stdlib.h>
#include <glib.h>
#include <gplugin.h>
/******************************************************************************
* Structs
*****************************************************************************/
typedef struct {
gchar *path;
GTestDataFunc func;
} GPluginTestLoaderFunction;
/******************************************************************************
* Tests
*****************************************************************************/
static void
gplugin_test_loader_full(gconstpointer d)
{
GPluginManager *manager = gplugin_manager_get_default();
GPluginPlugin *plugin = NULL;
GPluginPluginInfo *info = NULL;
GError *error = NULL;
gchar *id = NULL;
gchar **authors = NULL;
const gchar *const r_authors[] = {"author1", NULL};
gint i;
id = g_strdup_printf("gplugin/%s-basic-plugin", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_assert_nonnull(plugin);
info = gplugin_plugin_get_info(plugin);
g_assert_nonnull(info);
g_assert_cmpstr(gplugin_plugin_info_get_id(info), ==, id);
g_free(id);
g_assert_cmpuint(gplugin_plugin_info_get_abi_version(info), ==, 0x01020304);
g_assert_cmpstr(gplugin_plugin_info_get_name(info), ==, "basic plugin");
authors = (gchar **)gplugin_plugin_info_get_authors(info);
for(i = 0; r_authors[i]; i++)
g_assert_cmpstr(authors[i], ==, r_authors[i]);
g_assert_cmpstr(gplugin_plugin_info_get_category(info), ==, "test");
g_assert_cmpstr(gplugin_plugin_info_get_version(info), ==, "version");
g_assert_cmpstr(gplugin_plugin_info_get_license_id(info), ==, "license");
g_assert_cmpstr(gplugin_plugin_info_get_summary(info), ==, "summary");
g_assert_cmpstr(
gplugin_plugin_info_get_description(info),
==,
"description");
g_assert_cmpstr(gplugin_plugin_info_get_website(info), ==, "website");
g_object_unref(G_OBJECT(info));
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_QUERIED);
gplugin_manager_load_plugin(manager, plugin, &error);
g_assert_no_error(error);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_LOADED);
gplugin_manager_unload_plugin(manager, plugin, &error);
g_assert_no_error(error);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_QUERIED);
g_object_unref(G_OBJECT(plugin));
}
static void
gplugin_test_loader_load_failed(gconstpointer d)
{
GPluginManager *manager = gplugin_manager_get_default();
GPluginPlugin *plugin = NULL;
GError *error = NULL;
gchar *id = NULL;
gboolean ret = FALSE;
id = g_strdup_printf("gplugin/%s-load-failed", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_free(id);
g_assert_nonnull(plugin);
ret = gplugin_manager_load_plugin(manager, plugin, &error);
g_assert_false(ret);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_LOAD_FAILED);
/* make sure that the plugin's error was set */
error = gplugin_plugin_get_error(plugin);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_object_unref(G_OBJECT(plugin));
}
static void
gplugin_test_loader_load_exception(gconstpointer d)
{
GPluginManager *manager = gplugin_manager_get_default();
GPluginPlugin *plugin = NULL;
GError *error = NULL;
gchar *id = NULL;
gboolean ret = FALSE;
id = g_strdup_printf("gplugin/%s-load-exception", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_free(id);
g_assert_nonnull(plugin);
ret = gplugin_manager_load_plugin(manager, plugin, &error);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_assert_false(ret);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_LOAD_FAILED);
/* make sure that the plugin's error was set */
error = gplugin_plugin_get_error(plugin);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_object_unref(G_OBJECT(plugin));
}
static void
gplugin_test_loader_unload_shutdown(gconstpointer d)
{
GPluginLoader *loader = NULL;
GPluginManager *manager = NULL;
GPluginPlugin *plugin = NULL;
GError *error = NULL;
gchar *id = NULL;
gboolean ret = FALSE;
manager = gplugin_manager_get_default();
id = g_strdup_printf("gplugin/%s-unload-shutdown", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_free(id);
g_assert_nonnull(plugin);
ret = gplugin_manager_load_plugin(manager, plugin, &error);
g_assert_no_error(error);
g_assert_true(ret);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_LOADED);
loader = gplugin_plugin_get_loader(plugin);
ret = gplugin_loader_unload_plugin(loader, plugin, TRUE, &error);
g_clear_object(&loader);
g_assert_no_error(error);
g_assert_true(ret);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_QUERIED);
g_object_unref(G_OBJECT(plugin));
}
static void
gplugin_test_loader_unload_failed(gconstpointer d)
{
GPluginManager *manager = gplugin_manager_get_default();
GPluginPlugin *plugin = NULL;
GError *error = NULL;
gchar *id = NULL;
gboolean ret = FALSE;
id = g_strdup_printf("gplugin/%s-unload-failed", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_free(id);
g_assert_nonnull(plugin);
ret = gplugin_manager_load_plugin(manager, plugin, &error);
g_assert_no_error(error);
g_assert_true(ret);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_LOADED);
ret = gplugin_manager_unload_plugin(manager, plugin, &error);
g_assert_false(ret);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_assert_cmpint(
gplugin_plugin_get_state(plugin),
==,
GPLUGIN_PLUGIN_STATE_UNLOAD_FAILED);
/* make sure that the plugin's error was set */
error = gplugin_plugin_get_error(plugin);
g_assert_error(error, GPLUGIN_DOMAIN, 0);
g_clear_error(&error);
g_object_unref(G_OBJECT(plugin));
}
static void
gplugin_test_loader_dependencies(gconstpointer d)
{
GPluginManager *manager = gplugin_manager_get_default();
GPluginPlugin *plugin = NULL;
GPluginPluginInfo *info = NULL;
gchar *id = NULL;
gchar **deps = NULL;
const gchar *const r_deps[] = {"dependency1", "dependency2", NULL};
gint i = 0;
id = g_strdup_printf("gplugin/%s-dependent-plugin", (const gchar *)d);
plugin = gplugin_manager_find_plugin(manager, id);
g_free(id);
g_assert_nonnull(plugin);
info = gplugin_plugin_get_info(plugin);
g_assert_nonnull(info);
deps = (gchar **)gplugin_plugin_info_get_dependencies(info);
for(i = 0; r_deps[i]; i++)
g_assert_cmpstr(r_deps[i], ==, deps[i]);
g_object_unref(G_OBJECT(plugin));
}
/******************************************************************************
* Main
*****************************************************************************/
static GPluginTestLoaderFunction test_functions[] = {
{"/loaders/%s/full", gplugin_test_loader_full},
{"/loaders/%s/load-failed", gplugin_test_loader_load_failed},
{"/loaders/%s/load-exception", gplugin_test_loader_load_exception},
{"/loaders/%s/unload-failed", gplugin_test_loader_unload_failed},
{"/loaders/%s/unload-shutdown", gplugin_test_loader_unload_shutdown},
{"/loaders/%s/dependencies", gplugin_test_loader_dependencies},
{NULL, NULL},
};
void
gplugin_loader_tests_add_tests(const gchar *short_name)
{
gint i = 0;
for(i = 0; test_functions[i].path; i++) {
gchar *path = g_strdup_printf(test_functions[i].path, short_name);
g_test_add_data_func(path, short_name, test_functions[i].func);
g_free(path);
}
}
void
gplugin_loader_tests_main(
const gchar *loader_dir,
const gchar *plugin_dir,
const gchar *short_name)
{
GPluginManager *manager = NULL;
gplugin_init(GPLUGIN_CORE_FLAGS_NONE);
manager = gplugin_manager_get_default();
g_setenv("GI_TYPELIB_PATH", GI_TYPELIB_PATH, TRUE);
if(loader_dir) {
gplugin_manager_append_path(manager, loader_dir);
}
if(plugin_dir) {
gplugin_manager_append_path(manager, plugin_dir);
}
gplugin_manager_refresh(manager);
gplugin_loader_tests_add_tests(short_name);
}