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-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/>.
*/
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include "gplugin-python3-plugin.h"
/******************************************************************************
* Typedefs
*****************************************************************************/
struct _GPluginPython3Plugin {
GObject parent;
PyObject *module;
PyObject *load;
PyObject *unload;
/* overrides */
gchar *filename;
GPluginLoader *loader;
GPluginPluginInfo *info;
GPluginPluginState state;
GError *error;
};
/******************************************************************************
* Enums
*****************************************************************************/
enum {
PROP_ZERO,
PROP_MODULE,
PROP_LOAD_FUNC,
PROP_UNLOAD_FUNC,
N_PROPERTIES,
/* overrides */
PROP_FILENAME = N_PROPERTIES,
PROP_LOADER,
PROP_INFO,
PROP_STATE,
PROP_ERROR,
};
static GParamSpec *properties[N_PROPERTIES] = {
NULL,
};
/* I hate forward declarations... */
static void gplugin_python3_plugin_iface_init(GPluginPluginInterface *iface);
G_DEFINE_DYNAMIC_TYPE_EXTENDED(
GPluginPython3Plugin,
gplugin_python3_plugin,
G_TYPE_OBJECT,
0,
G_IMPLEMENT_INTERFACE(
GPLUGIN_TYPE_PLUGIN,
gplugin_python3_plugin_iface_init))
/******************************************************************************
* GPluginPlugin Implementation
*****************************************************************************/
static void
gplugin_python3_plugin_iface_init(G_GNUC_UNUSED GPluginPluginInterface *iface)
{
}
/******************************************************************************
* Private Stuff
*****************************************************************************/
static void
gplugin_python3_plugin_set_module(
GPluginPython3Plugin *plugin,
PyObject *module)
{
g_return_if_fail(GPLUGIN_IS_PLUGIN(plugin));
g_return_if_fail(module);
Py_XINCREF(module);
Py_CLEAR(plugin->module);
plugin->module = module;
}
static gpointer
gplugin_python3_plugin_get_load_func(GPluginPython3Plugin *plugin)
{
g_return_val_if_fail(GPLUGIN_PYTHON3_IS_PLUGIN(plugin), NULL);
return plugin->load;
}
static void
gplugin_python3_plugin_set_load_func(
GPluginPython3Plugin *plugin,
PyObject *func)
{
g_return_if_fail(GPLUGIN_PYTHON3_IS_PLUGIN(plugin));
g_return_if_fail(func != NULL);
Py_XINCREF(func);
Py_CLEAR(plugin->load);
plugin->load = func;
}
static gpointer
gplugin_python3_plugin_get_unload_func(GPluginPython3Plugin *plugin)
{
g_return_val_if_fail(GPLUGIN_PYTHON3_IS_PLUGIN(plugin), NULL);
return plugin->unload;
}
static void
gplugin_python3_plugin_set_unload_func(
GPluginPython3Plugin *plugin,
PyObject *func)
{
g_return_if_fail(GPLUGIN_PYTHON3_IS_PLUGIN(plugin));
g_return_if_fail(func != NULL);
Py_XINCREF(func);
Py_CLEAR(plugin->unload);
plugin->unload = func;
}
/******************************************************************************
* GObject Implementation
*****************************************************************************/
static void
gplugin_python3_plugin_get_property(
GObject *obj,
guint param_id,
GValue *value,
GParamSpec *pspec)
{
GPluginPython3Plugin *plugin = GPLUGIN_PYTHON3_PLUGIN(obj);
switch(param_id) {
case PROP_MODULE:
g_value_set_pointer(value, plugin->module);
break;
case PROP_LOAD_FUNC:
g_value_set_pointer(
value,
gplugin_python3_plugin_get_load_func(plugin));
break;
case PROP_UNLOAD_FUNC:
g_value_set_pointer(
value,
gplugin_python3_plugin_get_unload_func(plugin));
break;
/* overrides */
case PROP_FILENAME:
g_value_set_string(value, plugin->filename);
break;
case PROP_LOADER:
g_value_set_object(value, plugin->loader);
break;
case PROP_INFO:
g_value_set_object(value, plugin->info);
break;
case PROP_STATE:
g_value_set_enum(value, plugin->state);
break;
case PROP_ERROR:
g_value_set_boxed(value, plugin->error);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
gplugin_python3_plugin_set_property(
GObject *obj,
guint param_id,
const GValue *value,
GParamSpec *pspec)
{
GPluginPython3Plugin *plugin = GPLUGIN_PYTHON3_PLUGIN(obj);
switch(param_id) {
case PROP_MODULE:
gplugin_python3_plugin_set_module(
plugin,
g_value_get_pointer(value));
break;
case PROP_LOAD_FUNC:
gplugin_python3_plugin_set_load_func(
plugin,
g_value_get_pointer(value));
break;
case PROP_UNLOAD_FUNC:
gplugin_python3_plugin_set_unload_func(
plugin,
g_value_get_pointer(value));
break;
/* overrides */
case PROP_FILENAME:
plugin->filename = g_value_dup_string(value);
break;
case PROP_LOADER:
plugin->loader = g_value_dup_object(value);
break;
case PROP_INFO:
plugin->info = g_value_dup_object(value);
break;
case PROP_STATE:
plugin->state = g_value_get_enum(value);
break;
case PROP_ERROR:
plugin->error = g_value_dup_boxed(value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, param_id, pspec);
break;
}
}
static void
gplugin_python3_plugin_finalize(GObject *obj)
{
GPluginPython3Plugin *plugin = GPLUGIN_PYTHON3_PLUGIN(obj);
Py_CLEAR(plugin->module);
Py_CLEAR(plugin->load);
Py_CLEAR(plugin->unload);
g_clear_pointer(&plugin->filename, g_free);
g_clear_object(&plugin->loader);
g_clear_object(&plugin->info);
g_clear_error(&plugin->error);
G_OBJECT_CLASS(gplugin_python3_plugin_parent_class)->finalize(obj);
}
static void
gplugin_python3_plugin_init(G_GNUC_UNUSED GPluginPython3Plugin *plugin)
{
}
static void
gplugin_python3_plugin_class_finalize(
G_GNUC_UNUSED GPluginPython3PluginClass *klass)
{
}
static void
gplugin_python3_plugin_class_init(GPluginPython3PluginClass *klass)
{
GObjectClass *obj_class = G_OBJECT_CLASS(klass);
obj_class->get_property = gplugin_python3_plugin_get_property;
obj_class->set_property = gplugin_python3_plugin_set_property;
obj_class->finalize = gplugin_python3_plugin_finalize;
properties[PROP_MODULE] = g_param_spec_pointer(
"module",
"module",
"The python module object",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
properties[PROP_LOAD_FUNC] = g_param_spec_pointer(
"load-func",
"load-func",
"The python load function",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
properties[PROP_UNLOAD_FUNC] = g_param_spec_pointer(
"unload-func",
"unload-func",
"The python unload function",
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
g_object_class_install_properties(obj_class, N_PROPERTIES, properties);
/* add our overrides */
g_object_class_override_property(obj_class, PROP_FILENAME, "filename");
g_object_class_override_property(obj_class, PROP_LOADER, "loader");
g_object_class_override_property(obj_class, PROP_INFO, "info");
g_object_class_override_property(obj_class, PROP_STATE, "state");
g_object_class_override_property(obj_class, PROP_ERROR, "error");
}
/******************************************************************************
* API
*****************************************************************************/
void
gplugin_python3_plugin_register(GTypeModule *module)
{
gplugin_python3_plugin_register_type(module);
}