gimp/libgimp/gimppdbprocedure.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"

#define GIMP_DISABLE_COMPAT_CRUFT

#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 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->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 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_params;
  gint             n_return_vals;
  gint             i;

  g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
  g_return_val_if_fail (name != NULL, NULL);

  _gimp_pdb_proc_info (name,
                       &blurb,
                       &help,
                       /* FIXME &help_id, */
                       &authors,
                       &copyright,
                       &date,
                       &type,
                       &n_params,
                       &n_return_vals);

  help_id = g_strdup (name); /* FIXME */

  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_procedure_set_documentation (procedure, blurb, help, help_id);
  gimp_procedure_set_attribution (procedure, authors, copyright, date);

  g_free (blurb);
  g_free (help);
  g_free (help_id);
  g_free (authors);
  g_free (copyright);
  g_free (date);

  for (i = 0; i < n_params; i++)
    {
      GParamSpec *pspec = _gimp_pdb_proc_argument (name, i);

      gimp_procedure_add_argument (procedure, pspec);
    }

  for (i = 0; i < n_return_vals; i++)
    {
      GParamSpec *pspec = _gimp_pdb_proc_return_value (name, i);

      gimp_procedure_add_return_value (procedure, pspec);
    }

  return procedure;
}