gimpimageprocedure.c 7.51 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimpimageprocedure.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 "gimpimageprocedure.h"


struct _GimpImageProcedurePrivate
{
  GimpRunImageFunc run_func;
  gpointer         run_data;
  GDestroyNotify   run_data_destroy;
};


36 37
static void   gimp_image_procedure_constructed   (GObject              *object);
static void   gimp_image_procedure_finalize      (GObject              *object);
38 39

static GimpValueArray *
40 41 42 43 44 45
              gimp_image_procedure_run           (GimpProcedure        *procedure,
                                                  const GimpValueArray *args);
static GimpProcedureConfig *
              gimp_image_procedure_create_config (GimpProcedure        *procedure,
                                                  GParamSpec          **args,
                                                  gint                  n_args);
46 47 48 49 50 51 52 53 54 55 56 57 58 59


G_DEFINE_TYPE_WITH_PRIVATE (GimpImageProcedure, gimp_image_procedure,
                            GIMP_TYPE_PROCEDURE)

#define parent_class gimp_image_procedure_parent_class


static void
gimp_image_procedure_class_init (GimpImageProcedureClass *klass)
{
  GObjectClass       *object_class    = G_OBJECT_CLASS (klass);
  GimpProcedureClass *procedure_class = GIMP_PROCEDURE_CLASS (klass);

60 61
  object_class->constructed      = gimp_image_procedure_constructed;
  object_class->finalize         = gimp_image_procedure_finalize;
62

63 64
  procedure_class->run           = gimp_image_procedure_run;
  procedure_class->create_config = gimp_image_procedure_create_config;
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
}

static void
gimp_image_procedure_init (GimpImageProcedure *procedure)
{
  procedure->priv = gimp_image_procedure_get_instance_private (procedure);
}

static void
gimp_image_procedure_constructed (GObject *object)
{
  GimpProcedure *procedure = GIMP_PROCEDURE (object);

  G_OBJECT_CLASS (parent_class)->constructed (object);

80 81 82 83 84 85 86 87 88 89
  GIMP_PROC_ARG_ENUM (procedure, "run-mode",
                      "Run mode",
                      "The run mode",
                      GIMP_TYPE_RUN_MODE,
                      GIMP_RUN_NONINTERACTIVE,
                      G_PARAM_READWRITE);

  GIMP_PROC_ARG_IMAGE (procedure, "image",
                       "Image",
                       "The input image",
90
                       FALSE,
91 92 93 94 95
                       G_PARAM_READWRITE);

  GIMP_PROC_ARG_DRAWABLE (procedure, "drawable",
                          "Drawable",
                          "The input drawable",
96
                          TRUE,
97
                          G_PARAM_READWRITE);
98 99 100 101 102 103 104 105 106 107 108 109 110
}

static void
gimp_image_procedure_finalize (GObject *object)
{
  GimpImageProcedure *procedure = GIMP_IMAGE_PROCEDURE (object);

  if (procedure->priv->run_data_destroy)
    procedure->priv->run_data_destroy (procedure->priv->run_data);

  G_OBJECT_CLASS (parent_class)->finalize (object);
}

111 112
#define ARG_OFFSET 3

113 114 115 116 117 118 119 120
static GimpValueArray *
gimp_image_procedure_run (GimpProcedure        *procedure,
                          const GimpValueArray *args)
{
  GimpImageProcedure *image_proc = GIMP_IMAGE_PROCEDURE (procedure);
  GimpValueArray     *remaining;
  GimpValueArray     *return_values;
  GimpRunMode         run_mode;
121 122
  GimpImage          *image;
  GimpDrawable       *drawable;
123 124
  gint                i;

125 126 127
  run_mode = GIMP_VALUES_GET_ENUM     (args, 0);
  image    = GIMP_VALUES_GET_IMAGE    (args, 1);
  drawable = GIMP_VALUES_GET_DRAWABLE (args, 2);
128

129
  remaining = gimp_value_array_new (gimp_value_array_length (args) - ARG_OFFSET);
130

131
  for (i = ARG_OFFSET; i < gimp_value_array_length (args); i++)
132 133 134 135 136 137 138 139
    {
      GValue *value = gimp_value_array_index (args, i);

      gimp_value_array_append (remaining, value);
    }

  return_values = image_proc->priv->run_func (procedure,
                                              run_mode,
140
                                              image, drawable,
141 142 143 144 145 146 147 148
                                              remaining,
                                              image_proc->priv->run_data);

  gimp_value_array_unref (remaining);

  return return_values;
}

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
static GimpProcedureConfig *
gimp_image_procedure_create_config (GimpProcedure  *procedure,
                                    GParamSpec    **args,
                                    gint            n_args)
{
  if (n_args > ARG_OFFSET)
    {
      args   += ARG_OFFSET;
      n_args -= ARG_OFFSET;
    }
  else
    {
      args   = NULL;
      n_args = 0;
    }

  return GIMP_PROCEDURE_CLASS (parent_class)->create_config (procedure,
                                                             args,
                                                             n_args);
}

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197

/*  public functions  */

/**
 * gimp_image_procedure_new:
 * @plug_in:          a #GimpPlugIn.
 * @name:             the new procedure's name.
 * @proc_type:        the new procedure's #GimpPDBProcType.
 * @run_func:         the run function for the new procedure.
 * @run_data:         user data passed to @run_func.
 * @run_data_destroy: (nullable): free function for @run_data, or %NULL.
 *
 * Creates a new image procedure named @name which will call @run_func
 * when invoked.
 *
 * See gimp_procedure_new() for information about @proc_type.
 *
 * #GimpImageProcedure is a #GimpProcedure subclass that makes it easier
 * to write standard plug-in procedures that operate on drawables.
 *
 * It automatically adds the standard
 *
 * (run-mode, image-id, drawable-id)
 *
 * arguments of an image procedure. It is possible to add additional
 * arguments.
 *
 * When invoked via gimp_procedure_run(), it unpacks these standard
luz.paz's avatar
luz.paz committed
198
 * arguments and calls @run_func which is a #GimpRunImageFunc. The
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
 * "args" #GimpValueArray of #GimpRunImageFunc only contains
 * additionally added arguments.
 *
 * Returns: a new #GimpProcedure.
 *
 * Since: 3.0
 **/
GimpProcedure  *
gimp_image_procedure_new (GimpPlugIn       *plug_in,
                          const gchar      *name,
                          GimpPDBProcType   proc_type,
                          GimpRunImageFunc  run_func,
                          gpointer          run_data,
                          GDestroyNotify    run_data_destroy)
{
  GimpImageProcedure *procedure;

  g_return_val_if_fail (GIMP_IS_PLUG_IN (plug_in), NULL);
  g_return_val_if_fail (gimp_is_canonical_identifier (name), NULL);
218 219
  g_return_val_if_fail (proc_type != GIMP_PDB_PROC_TYPE_INTERNAL, NULL);
  g_return_val_if_fail (proc_type != GIMP_PDB_PROC_TYPE_EXTENSION, NULL);
220 221 222 223 224 225 226 227 228 229 230 231 232 233
  g_return_val_if_fail (run_func != NULL, NULL);

  procedure = g_object_new (GIMP_TYPE_IMAGE_PROCEDURE,
                            "plug-in",        plug_in,
                            "name",           name,
                            "procedure-type", proc_type,
                            NULL);

  procedure->priv->run_func         = run_func;
  procedure->priv->run_data         = run_data;
  procedure->priv->run_data_destroy = run_data_destroy;

  return GIMP_PROCEDURE (procedure);
}