gimp/libgimp/gimppdbprocedure.c
Jehan ac030a0cd7 libgimp, plug-ins: make generic gimp_procedure_add_argument() private.
Same for gimp_procedure_add_aux_argument() and gimp_procedure_add_return_value().

We now have specific public functions for every supported type and it's
in fact much better to use them. The generic functions gave the feeling
that we could use any GParamSpec as procedure argument, whereas we in
fact depend on what the PDB support, and only these subtypes.
2024-07-06 14:44:45 +02:00

269 lines
8 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimppdbprocedure.c
* Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "config.h"
#include "gimp.h"
#include "gimppdb-private.h"
#include "gimppdb_pdb.h"
#include "gimppdbprocedure.h"
enum
{
PROP_0,
PROP_PDB,
N_PROPS
};
struct _GimpPDBProcedurePrivate
{
GimpPDB *pdb;
};
static void gimp_pdb_procedure_constructed (GObject *object);
static void gimp_pdb_procedure_finalize (GObject *object);
static void gimp_pdb_procedure_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_pdb_procedure_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static void gimp_pdb_procedure_install (GimpProcedure *procedure);
static void gimp_pdb_procedure_uninstall (GimpProcedure *procedure);
static GimpValueArray *
gimp_pdb_procedure_run (GimpProcedure *procedure,
const GimpValueArray *args);
G_DEFINE_TYPE_WITH_PRIVATE (GimpPDBProcedure, _gimp_pdb_procedure,
GIMP_TYPE_PROCEDURE)
#define parent_class _gimp_pdb_procedure_parent_class
static GParamSpec *props[N_PROPS] = { NULL, };
static void
_gimp_pdb_procedure_class_init (GimpPDBProcedureClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GimpProcedureClass *procedure_class = GIMP_PROCEDURE_CLASS (klass);
object_class->constructed = gimp_pdb_procedure_constructed;
object_class->finalize = gimp_pdb_procedure_finalize;
object_class->set_property = gimp_pdb_procedure_set_property;
object_class->get_property = gimp_pdb_procedure_get_property;
procedure_class->install = gimp_pdb_procedure_install;
procedure_class->uninstall = gimp_pdb_procedure_uninstall;
procedure_class->run = gimp_pdb_procedure_run;
props[PROP_PDB] =
g_param_spec_object ("pdb",
"PDB",
"The GimpPDB of this plug-in process",
GIMP_TYPE_PDB,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY);
g_object_class_install_properties (object_class, N_PROPS, props);
}
static void
_gimp_pdb_procedure_init (GimpPDBProcedure *procedure)
{
procedure->priv = _gimp_pdb_procedure_get_instance_private (procedure);
}
static void
gimp_pdb_procedure_constructed (GObject *object)
{
GimpPDBProcedure *procedure = GIMP_PDB_PROCEDURE (object);
G_OBJECT_CLASS (parent_class)->constructed (object);
g_assert (GIMP_IS_PDB (procedure->priv->pdb));
}
static void
gimp_pdb_procedure_finalize (GObject *object)
{
GimpPDBProcedure *procedure = GIMP_PDB_PROCEDURE (object);
g_clear_object (&procedure->priv->pdb);
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static void
gimp_pdb_procedure_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpPDBProcedure *procedure = GIMP_PDB_PROCEDURE (object);
switch (property_id)
{
case PROP_PDB:
g_set_object (&procedure->priv->pdb, g_value_get_object (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_pdb_procedure_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpPDBProcedure *procedure = GIMP_PDB_PROCEDURE (object);
switch (property_id)
{
case PROP_PDB:
g_value_set_object (value, procedure->priv->pdb);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_pdb_procedure_install (GimpProcedure *procedure)
{
g_warning ("Cannot install a GimpPDBProcedure");
}
static void
gimp_pdb_procedure_uninstall (GimpProcedure *procedure)
{
g_warning ("Cannot uninstall a GimpPDBProcedure");
}
static GimpValueArray *
gimp_pdb_procedure_run (GimpProcedure *procedure,
const GimpValueArray *args)
{
GimpPDBProcedure *pdb_procedure = GIMP_PDB_PROCEDURE (procedure);
return _gimp_pdb_run_procedure_array (pdb_procedure->priv->pdb,
gimp_procedure_get_name (procedure),
(GimpValueArray *) args);
}
/* public functions */
GimpProcedure *
_gimp_pdb_procedure_new (GimpPDB *pdb,
const gchar *name)
{
GimpProcedure *procedure;
gchar *blurb;
gchar *help;
gchar *help_id;
gchar *authors;
gchar *copyright;
gchar *date;
GimpPDBProcType type;
gint n_args;
gint n_return_vals;
gint i;
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
g_return_val_if_fail (gimp_is_canonical_identifier (name), NULL);
_gimp_pdb_get_proc_info (name, &type, &n_args, &n_return_vals);
procedure = g_object_new (GIMP_TYPE_PDB_PROCEDURE,
"plug-in", _gimp_pdb_get_plug_in (pdb),
"name", name,
"procedure-type", type,
"pdb", pdb,
NULL);
_gimp_pdb_get_proc_documentation (name, &blurb, &help, &help_id);
gimp_procedure_set_documentation (procedure, blurb, help, help_id);
g_free (blurb);
g_free (help);
g_free (help_id);
_gimp_pdb_get_proc_attribution (name, &authors, &copyright, &date);
gimp_procedure_set_attribution (procedure, authors, copyright, date);
g_free (authors);
g_free (copyright);
g_free (date);
for (i = 0; i < n_args; i++)
{
GParamSpec *pspec = _gimp_pdb_get_proc_argument (name, i);
_gimp_procedure_add_argument (procedure, pspec);
}
for (i = 0; i < n_return_vals; i++)
{
GParamSpec *pspec = _gimp_pdb_get_proc_return_value (name, i);
_gimp_procedure_add_return_value (procedure, pspec);
}
if (type != GIMP_PDB_PROC_TYPE_INTERNAL)
{
gchar *string;
gchar **menu_paths;
gchar **path;
string = _gimp_pdb_get_proc_image_types (name);
if (string)
{
gimp_procedure_set_image_types (procedure, string);
g_free (string);
}
string = _gimp_pdb_get_proc_menu_label (name);
if (string)
{
gimp_procedure_set_menu_label (procedure, string);
g_free (string);
}
menu_paths = _gimp_pdb_get_proc_menu_paths (name);
for (path = menu_paths; path && *path; path++)
gimp_procedure_add_menu_path (procedure, *path);
g_strfreev (menu_paths);
}
return procedure;
}