/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* 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 .
*/
#include "config.h"
#include
#include
#include
#include "libgimpbase/gimpbase.h"
#include "libgimpcolor/gimpcolor.h"
#include "pdb-types.h"
#include "core/gimp.h"
#include "core/gimpparamspecs.h"
#include "gimppdb.h"
#include "gimp-pdb-compat.h"
/* local function prototypes */
static gchar * gimp_pdb_compat_fix_param_name (const gchar *name);
/* public functions */
GParamSpec *
gimp_pdb_compat_param_spec (Gimp *gimp,
GimpPDBArgType arg_type,
const gchar *name,
const gchar *desc,
gboolean *name_valid)
{
GParamSpec *pspec = NULL;
gchar *real_name;
g_return_val_if_fail (GIMP_IS_GIMP (gimp), NULL);
g_return_val_if_fail (name != NULL, NULL);
real_name = gimp_pdb_compat_fix_param_name (name);
if (name_valid) *name_valid = ! strcmp (name, real_name);
switch (arg_type)
{
case GIMP_PDB_INT32:
pspec = gimp_param_spec_int32 (real_name, real_name, desc,
G_MININT32, G_MAXINT32, 0,
G_PARAM_READWRITE);
break;
case GIMP_PDB_INT16:
pspec = gimp_param_spec_int16 (real_name, real_name, desc,
G_MININT16, G_MAXINT16, 0,
G_PARAM_READWRITE);
break;
case GIMP_PDB_INT8:
pspec = gimp_param_spec_int8 (real_name, real_name, desc,
0, G_MAXUINT8, 0,
G_PARAM_READWRITE);
break;
case GIMP_PDB_FLOAT:
pspec = g_param_spec_double (real_name, real_name, desc,
-G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
G_PARAM_READWRITE);
break;
case GIMP_PDB_STRING:
pspec = gimp_param_spec_string (real_name, real_name, desc,
TRUE, TRUE, FALSE,
NULL,
G_PARAM_READWRITE);
break;
case GIMP_PDB_INT32ARRAY:
pspec = gimp_param_spec_int32_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_INT16ARRAY:
pspec = gimp_param_spec_int16_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_INT8ARRAY:
pspec = gimp_param_spec_int8_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_FLOATARRAY:
pspec = gimp_param_spec_float_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_STRINGARRAY:
pspec = gimp_param_spec_string_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_COLOR:
pspec = gimp_param_spec_rgb (real_name, real_name, desc,
TRUE, NULL,
G_PARAM_READWRITE);
break;
case GIMP_PDB_ITEM:
pspec = gimp_param_spec_item_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_DISPLAY:
pspec = gimp_param_spec_display_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_IMAGE:
pspec = gimp_param_spec_image_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_LAYER:
pspec = gimp_param_spec_layer_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_CHANNEL:
pspec = gimp_param_spec_channel_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_DRAWABLE:
pspec = gimp_param_spec_drawable_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_SELECTION:
pspec = gimp_param_spec_selection_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_COLORARRAY:
pspec = gimp_param_spec_color_array (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_VECTORS:
pspec = gimp_param_spec_vectors_id (real_name, real_name, desc,
gimp, TRUE,
G_PARAM_READWRITE);
break;
case GIMP_PDB_PARASITE:
pspec = gimp_param_spec_parasite (real_name, real_name, desc,
G_PARAM_READWRITE);
break;
case GIMP_PDB_STATUS:
pspec = g_param_spec_enum (real_name, real_name, desc,
GIMP_TYPE_PDB_STATUS_TYPE,
GIMP_PDB_EXECUTION_ERROR,
G_PARAM_READWRITE);
break;
case GIMP_PDB_END:
break;
}
if (! pspec)
{
g_warning ("%s: returning NULL for %s (%s)",
G_STRFUNC,
real_name,
gimp_pdb_compat_arg_type_to_string (arg_type));
}
g_free (real_name);
return pspec;
}
GType
gimp_pdb_compat_arg_type_to_gtype (GimpPDBArgType type)
{
switch (type)
{
case GIMP_PDB_INT32:
return GIMP_TYPE_INT32;
case GIMP_PDB_INT16:
return GIMP_TYPE_INT16;
case GIMP_PDB_INT8:
return GIMP_TYPE_INT8;
case GIMP_PDB_FLOAT:
return G_TYPE_DOUBLE;
case GIMP_PDB_STRING:
return G_TYPE_STRING;
case GIMP_PDB_INT32ARRAY:
return GIMP_TYPE_INT32_ARRAY;
case GIMP_PDB_INT16ARRAY:
return GIMP_TYPE_INT16_ARRAY;
case GIMP_PDB_INT8ARRAY:
return GIMP_TYPE_INT8_ARRAY;
case GIMP_PDB_FLOATARRAY:
return GIMP_TYPE_FLOAT_ARRAY;
case GIMP_PDB_STRINGARRAY:
return GIMP_TYPE_STRING_ARRAY;
case GIMP_PDB_COLOR:
return GIMP_TYPE_RGB;
case GIMP_PDB_ITEM:
return GIMP_TYPE_ITEM_ID;
case GIMP_PDB_DISPLAY:
return GIMP_TYPE_DISPLAY_ID;
case GIMP_PDB_IMAGE:
return GIMP_TYPE_IMAGE_ID;
case GIMP_PDB_LAYER:
return GIMP_TYPE_LAYER_ID;
case GIMP_PDB_CHANNEL:
return GIMP_TYPE_CHANNEL_ID;
case GIMP_PDB_DRAWABLE:
return GIMP_TYPE_DRAWABLE_ID;
case GIMP_PDB_SELECTION:
return GIMP_TYPE_SELECTION_ID;
case GIMP_PDB_COLORARRAY:
return GIMP_TYPE_COLOR_ARRAY;
case GIMP_PDB_VECTORS:
return GIMP_TYPE_VECTORS_ID;
case GIMP_PDB_PARASITE:
return GIMP_TYPE_PARASITE;
case GIMP_PDB_STATUS:
return GIMP_TYPE_PDB_STATUS_TYPE;
case GIMP_PDB_END:
break;
}
g_warning ("%s: returning G_TYPE_NONE for %d (%s)",
G_STRFUNC, type, gimp_pdb_compat_arg_type_to_string (type));
return G_TYPE_NONE;
}
GimpPDBArgType
gimp_pdb_compat_arg_type_from_gtype (GType type)
{
static GQuark pdb_type_quark = 0;
GimpPDBArgType pdb_type;
if (! pdb_type_quark)
{
struct
{
GType g_type;
GimpPDBArgType pdb_type;
}
type_mapping[] =
{
{ GIMP_TYPE_INT32, GIMP_PDB_INT32 },
{ G_TYPE_INT, GIMP_PDB_INT32 },
{ G_TYPE_UINT, GIMP_PDB_INT32 },
{ G_TYPE_ENUM, GIMP_PDB_INT32 },
{ G_TYPE_BOOLEAN, GIMP_PDB_INT32 },
{ GIMP_TYPE_INT16, GIMP_PDB_INT16 },
{ GIMP_TYPE_INT8, GIMP_PDB_INT8 },
{ G_TYPE_DOUBLE, GIMP_PDB_FLOAT },
{ G_TYPE_STRING, GIMP_PDB_STRING },
{ GIMP_TYPE_RGB, GIMP_PDB_COLOR },
{ GIMP_TYPE_INT32_ARRAY, GIMP_PDB_INT32ARRAY },
{ GIMP_TYPE_INT16_ARRAY, GIMP_PDB_INT16ARRAY },
{ GIMP_TYPE_INT8_ARRAY, GIMP_PDB_INT8ARRAY },
{ GIMP_TYPE_FLOAT_ARRAY, GIMP_PDB_FLOATARRAY },
{ GIMP_TYPE_STRING_ARRAY, GIMP_PDB_STRINGARRAY },
{ GIMP_TYPE_COLOR_ARRAY, GIMP_PDB_COLORARRAY },
{ GIMP_TYPE_ITEM_ID, GIMP_PDB_ITEM },
{ GIMP_TYPE_DISPLAY_ID, GIMP_PDB_DISPLAY },
{ GIMP_TYPE_IMAGE_ID, GIMP_PDB_IMAGE },
{ GIMP_TYPE_LAYER_ID, GIMP_PDB_LAYER },
{ GIMP_TYPE_CHANNEL_ID, GIMP_PDB_CHANNEL },
{ GIMP_TYPE_DRAWABLE_ID, GIMP_PDB_DRAWABLE },
{ GIMP_TYPE_SELECTION_ID, GIMP_PDB_SELECTION },
{ GIMP_TYPE_LAYER_MASK_ID, GIMP_PDB_CHANNEL },
{ GIMP_TYPE_VECTORS_ID, GIMP_PDB_VECTORS },
{ GIMP_TYPE_PARASITE, GIMP_PDB_PARASITE },
{ GIMP_TYPE_PDB_STATUS_TYPE, GIMP_PDB_STATUS }
};
gint i;
pdb_type_quark = g_quark_from_static_string ("gimp-pdb-type");
for (i = 0; i < G_N_ELEMENTS (type_mapping); i++)
g_type_set_qdata (type_mapping[i].g_type, pdb_type_quark,
GINT_TO_POINTER (type_mapping[i].pdb_type));
}
pdb_type = GPOINTER_TO_INT (g_type_get_qdata (type, pdb_type_quark));
#if 0
g_printerr ("%s: arg_type = %p (%s) -> %d (%s)\n",
G_STRFUNC,
(gpointer) type, g_type_name (type),
pdb_type, gimp_pdb_arg_type_to_string (pdb_type));
#endif
return pdb_type;
}
gchar *
gimp_pdb_compat_arg_type_to_string (GimpPDBArgType type)
{
const gchar *name;
if (! gimp_enum_get_value (GIMP_TYPE_PDB_ARG_TYPE, type,
&name, NULL, NULL, NULL))
{
return g_strdup_printf ("(PDB type %d unknown)", type);
}
return g_strdup (name);
}
void
gimp_pdb_compat_procs_register (GimpPDB *pdb,
GimpPDBCompatMode compat_mode)
{
static const struct
{
const gchar *old_name;
const gchar *new_name;
}
compat_procs[] =
{
{ "gimp-blend", "gimp-edit-blend" },
{ "gimp-brushes-list", "gimp-brushes-get-list" },
{ "gimp-bucket-fill", "gimp-edit-bucket-fill" },
{ "gimp-channel-delete", "gimp-item-delete" },
{ "gimp-channel-get-name", "gimp-item-get-name" },
{ "gimp-channel-get-tattoo", "gimp-item-get-tattoo" },
{ "gimp-channel-get-visible", "gimp-item-get-visible" },
{ "gimp-channel-set-name", "gimp-item-set-name" },
{ "gimp-channel-set-tattoo", "gimp-item-set-tattoo" },
{ "gimp-channel-set-visible", "gimp-item-set-visible" },
{ "gimp-color-picker", "gimp-image-pick-color" },
{ "gimp-convert-grayscale", "gimp-image-convert-grayscale" },
{ "gimp-convert-indexed", "gimp-image-convert-indexed" },
{ "gimp-convert-rgb", "gimp-image-convert-rgb" },
{ "gimp-crop", "gimp-image-crop" },
{ "gimp-drawable-bytes", "gimp-drawable-bpp" },
{ "gimp-drawable-image", "gimp-drawable-get-image" },
{ "gimp-image-active-drawable", "gimp-image-get-active-drawable" },
{ "gimp-image-floating-selection", "gimp-image-get-floating-sel" },
{ "gimp-layer-delete", "gimp-item-delete" },
{ "gimp-layer-get-linked", "gimp-item-get-linked" },
{ "gimp-layer-get-name", "gimp-item-get-name" },
{ "gimp-layer-get-tattoo", "gimp-item-get-tattoo" },
{ "gimp-layer-get-visible", "gimp-item-get-visible" },
{ "gimp-layer-mask", "gimp-layer-get-mask" },
{ "gimp-layer-set-linked", "gimp-item-set-linked" },
{ "gimp-layer-set-name", "gimp-item-set-name" },
{ "gimp-layer-set-tattoo", "gimp-item-set-tattoo" },
{ "gimp-layer-set-visible", "gimp-item-set-visible" },
{ "gimp-palette-refresh", "gimp-palettes-refresh" },
{ "gimp-patterns-list", "gimp-patterns-get-list" },
{ "gimp-temp-PDB-name", "gimp-procedural-db-temp-name" },
{ "gimp-undo-push-group-end", "gimp-image-undo-group-end" },
{ "gimp-undo-push-group-start", "gimp-image-undo-group-start" },
/* deprecations since 2.0 */
{ "gimp-brushes-get-opacity", "gimp-context-get-opacity" },
{ "gimp-brushes-get-paint-mode", "gimp-context-get-paint-mode" },
{ "gimp-brushes-set-brush", "gimp-context-set-brush" },
{ "gimp-brushes-set-opacity", "gimp-context-set-opacity" },
{ "gimp-brushes-set-paint-mode", "gimp-context-set-paint-mode" },
{ "gimp-channel-ops-duplicate", "gimp-image-duplicate" },
{ "gimp-channel-ops-offset", "gimp-drawable-offset" },
{ "gimp-gradients-get-active", "gimp-context-get-gradient" },
{ "gimp-gradients-get-gradient", "gimp-context-get-gradient" },
{ "gimp-gradients-set-active", "gimp-context-set-gradient" },
{ "gimp-gradients-set-gradient", "gimp-context-set-gradient" },
{ "gimp-image-get-cmap", "gimp-image-get-colormap" },
{ "gimp-image-set-cmap", "gimp-image-set-colormap" },
{ "gimp-palette-get-background", "gimp-context-get-background" },
{ "gimp-palette-get-foreground", "gimp-context-get-foreground" },
{ "gimp-palette-set-background", "gimp-context-set-background" },
{ "gimp-palette-set-default-colors", "gimp-context-set-default-colors" },
{ "gimp-palette-set-foreground", "gimp-context-set-foreground" },
{ "gimp-palette-swap-colors", "gimp-context-swap-colors" },
{ "gimp-palettes-set-palette", "gimp-context-set-palette" },
{ "gimp-patterns-set-pattern", "gimp-context-set-pattern" },
{ "gimp-selection-clear", "gimp-selection-none" },
/* deprecations since 2.2 */
{ "gimp-layer-get-preserve-trans", "gimp-layer-get-lock-alpha" },
{ "gimp-layer-set-preserve-trans", "gimp-layer-set-lock-alpha" },
/* deprecations since 2.6 */
{ "gimp-drawable-is-valid", "gimp-item-is-valid" },
{ "gimp-drawable-is-layer", "gimp-item-is-layer" },
{ "gimp-drawable-is-text-layer", "gimp-item-is-text-layer" },
{ "gimp-drawable-is-layer-mask", "gimp-item-is-layer-mask" },
{ "gimp-drawable-is-channel", "gimp-item-is-channel" },
{ "gimp-drawable-delete", "gimp-item-delete" },
{ "gimp-drawable-get-image", "gimp-item-get-image" },
{ "gimp-drawable-get-name", "gimp-item-get-name" },
{ "gimp-drawable-set-name", "gimp-item-set-name" },
{ "gimp-drawable-get-visible", "gimp-item-get-visible" },
{ "gimp-drawable-set-visible", "gimp-item-set-visible" },
{ "gimp-drawable-get-linked", "gimp-item-get-linked" },
{ "gimp-drawable-set-linked", "gimp-item-set-linked" },
{ "gimp-drawable-get-tattoo", "gimp-item-get-tattoo" },
{ "gimp-drawable-set-tattoo", "gimp-item-set-tattoo" },
{ "gimp-drawable-parasite-find", "gimp-item-get-parasite" },
{ "gimp-drawable-parasite-attach", "gimp-item-attach-parasite" },
{ "gimp-drawable-parasite-detach", "gimp-item-detach-parasite" },
{ "gimp-drawable-parasite-list", "gimp-item-get-parasite-list" },
{ "gimp-image-get-layer-position", "gimp-image-get-item-position" },
{ "gimp-image-raise-layer", "gimp-image-raise-item" },
{ "gimp-image-lower-layer", "gimp-image-lower-item" },
{ "gimp-image-raise-layer-to-top", "gimp-image-raise-item-to-top" },
{ "gimp-image-lower-layer-to-bottom", "gimp-image-lower-item-to-bottom" },
{ "gimp-image-get-channel-position", "gimp-image-get-item-position" },
{ "gimp-image-raise-channel", "gimp-image-raise-item" },
{ "gimp-image-lower-channel", "gimp-image-lower-item" },
{ "gimp-image-get-vectors-position", "gimp-image-get-item-position" },
{ "gimp-image-raise-vectors", "gimp-image-raise-item" },
{ "gimp-image-lower-vectors", "gimp-image-lower-item" },
{ "gimp-image-raise-vectors-to-top", "gimp-image-raise-item-to-top" },
{ "gimp-image-lower-vectors-to-bottom", "gimp-image-lower-item-to-bottom" },
{ "gimp-vectors-is-valid", "gimp-item-is-valid" },
{ "gimp-vectors-get-image", "gimp-item-get-image" },
{ "gimp-vectors-get-name", "gimp-item-get-name" },
{ "gimp-vectors-set-name", "gimp-item-set-name" },
{ "gimp-vectors-get-visible", "gimp-item-get-visible" },
{ "gimp-vectors-set-visible", "gimp-item-set-visible" },
{ "gimp-vectors-get-linked", "gimp-item-get-linked" },
{ "gimp-vectors-set-linked", "gimp-item-set-linked" },
{ "gimp-vectors-get-tattoo", "gimp-item-get-tattoo" },
{ "gimp-vectors-set-tattoo", "gimp-item-set-tattoo" },
{ "gimp-vectors-parasite-find", "gimp-item-get-parasite" },
{ "gimp-vectors-parasite-attach", "gimp-item-attach-parasite" },
{ "gimp-vectors-parasite-detach", "gimp-item-detach-parasite" },
{ "gimp-vectors-parasite-list", "gimp-item-get-parasite-list" },
{ "gimp-image-parasite-find", "gimp-image-get-parasite" },
{ "gimp-image-parasite-attach", "gimp-image-attach-parasite" },
{ "gimp-image-parasite-detach", "gimp-image-detach-parasite" },
{ "gimp-image-parasite-list", "gimp-image-get-parasite-list" },
{ "gimp-parasite-find", "gimp-get-parasite" },
{ "gimp-parasite-attach", "gimp-attach-parasite" },
{ "gimp-parasite-detach", "gimp-detach-parasite" },
{ "gimp-parasite-list", "gimp-get-parasite-list" },
/* deprecations since 2.8 */
{ "gimp-edit-paste-as-new", "gimp-edit-paste-as-new-image" },
{ "gimp-edit-named-paste-as-new", "gimp-edit-named-paste-as-new-image" }
};
g_return_if_fail (GIMP_IS_PDB (pdb));
if (compat_mode != GIMP_PDB_COMPAT_OFF)
{
gint i;
for (i = 0; i < G_N_ELEMENTS (compat_procs); i++)
gimp_pdb_register_compat_proc_name (pdb,
compat_procs[i].old_name,
compat_procs[i].new_name);
}
}
/* private functions */
/* Since GLib 2.63.3, invalid param-spec names are rejected upon creation.
* This impacts procedure parameters and return-values, which are stored as
* param-specs internally. Since this requirement wasn't previously enforced,
* keep supporting arbitrary parameter names in gimp-2.
*
* See issues #4392 and #4641.
*/
static gchar *
gimp_pdb_compat_fix_param_name (const gchar *name)
{
GString *new_name;
new_name = g_string_new (NULL);
/* First character must be a letter. */
if ((name[0] < 'A' || name[0] > 'Z') &&
(name[0] < 'a' || name[0] > 'z'))
{
g_string_append (new_name, "param-");
}
for (; *name; name++)
{
gchar c = *name;
if ((c < 'A' || c > 'Z') &&
(c < 'a' || c > 'z') &&
(c < '0' || c > '9') &&
c != '-' && c != '_')
{
c = '-';
}
g_string_append_c (new_name, c);
}
return g_string_free (new_name, FALSE);
}