[gimp] ScriptFu: Extract informal class SFArg from script-fu-script.c
- From: Lloyd Konneker <lkonneker src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] ScriptFu: Extract informal class SFArg from script-fu-script.c
- Date: Mon, 4 Jul 2022 09:09:29 +0000 (UTC)
commit fadae20618a1118f526cc1eef33d25fc628bc759
Author: lloyd konneker <konnekerl gmail com>
Date: Sat Jul 2 15:11:08 2022 -0400
ScriptFu: Extract informal class SFArg from script-fu-script.c
Why: puts most methods for SFArg (a struct) in one place, for ease of maintenance.
Prepares to fix issue 8328. Prepares to make SF use GimpProcedureDialog.
Mostly moving code, with no intended change in functionality,
except fixed an property.nick for an arg is now what a script author provided,
instead of generated.
All internal to libscriptfu. No changes to the exported API or to i18n.
Lightly tested, since more substantive changes coming for issue 8328.
ScriptFu>Test>Sphere is the test case.
plug-ins/script-fu/libscriptfu/Makefile.am | 4 +-
plug-ins/script-fu/libscriptfu/meson.build | 1 +
plug-ins/script-fu/libscriptfu/script-fu-arg.c | 697 ++++++++++++++++++++++
plug-ins/script-fu/libscriptfu/script-fu-arg.h | 39 ++
plug-ins/script-fu/libscriptfu/script-fu-script.c | 630 +------------------
5 files changed, 753 insertions(+), 618 deletions(-)
---
diff --git a/plug-ins/script-fu/libscriptfu/Makefile.am b/plug-ins/script-fu/libscriptfu/Makefile.am
index 3800578fe6..748f0a7f82 100644
--- a/plug-ins/script-fu/libscriptfu/Makefile.am
+++ b/plug-ins/script-fu/libscriptfu/Makefile.am
@@ -121,7 +121,9 @@ libgimp_scriptfu_@GIMP_API_VERSION@_la_SOURCES = \
script-fu-lib.c \
script-fu-lib.h \
script-fu-proc-factory.h \
- script-fu-proc-factory.c
+ script-fu-proc-factory.c \
+ script-fu-arg.c \
+ script-fu-arg.h
EXTRA_libgimp_scriptfu_@GIMP_API_VERSION@_la_DEPENDENCIES = $(scriptfu_def)
diff --git a/plug-ins/script-fu/libscriptfu/meson.build b/plug-ins/script-fu/libscriptfu/meson.build
index ffad8b51bf..74f5df5b97 100644
--- a/plug-ins/script-fu/libscriptfu/meson.build
+++ b/plug-ins/script-fu/libscriptfu/meson.build
@@ -15,6 +15,7 @@ libscriptfu_sources = [
'script-fu-compat.c',
'script-fu-lib.c',
'script-fu-proc-factory.c',
+ 'script-fu-arg.c'
]
# !! just "library(...)" which means shared versus static depends on configuration of project.
diff --git a/plug-ins/script-fu/libscriptfu/script-fu-arg.c b/plug-ins/script-fu/libscriptfu/script-fu-arg.c
new file mode 100644
index 0000000000..e39ed775a9
--- /dev/null
+++ b/plug-ins/script-fu/libscriptfu/script-fu-arg.c
@@ -0,0 +1,697 @@
+/* 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 <https://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include <libgimp/gimp.h>
+#include <libgimp/gimpui.h>
+
+#include "script-fu-types.h"
+#include "script-fu-arg.h"
+#include "script-fu-utils.h"
+
+
+/*
+ * Methods of SFArg.
+ * SFArg is an informal class.
+ * All methods take first argument SFArg*, i.e. self.
+ *
+ * A SFArg is similar to a GValue and a GParamSpec.
+ * Like a GValue, it holds a value.
+ * Like a GParamSpec, it is metadata and holds a default value.
+ *
+ * In GIMP 2, extension-script-fu stays running and keeps instances of SFArg in memory.
+ * This is how ScriptFu "settings" aka "last values" are persistent for a session of GIMP.
+ *
+ * In GIMP 2, in the GUI implemented by ScriptFu (script-fu-interface.c),
+ * initial values of widgets are taken from SFArg (s),
+ * and result values of widgets are written back to SFArg.
+ *
+ * In GIMP 3, SFArg might be somewhat replaced with GimpConfig.
+ *
+ * Roughly, the methods hide how to convert/represent SFArgs back/forth
+ * to [GParamSpec, GValue, Scheme string representation.]
+ *
+ * Since SFArg is a union, similar to a GValue, the code is mostly switch on type.
+ */
+
+
+
+
+/* Free any allocated members.
+ * Somewhat hides what members of the SFArg struct are allocated.
+ * !!! A few other places in the code do the allocations.
+ * !!! A few other places in the code free members.
+ */
+void
+script_fu_arg_free (SFArg *arg)
+{
+ g_free (arg->label);
+
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ case SF_DRAWABLE:
+ case SF_LAYER:
+ case SF_CHANNEL:
+ case SF_VECTORS:
+ case SF_DISPLAY:
+ case SF_COLOR:
+ case SF_TOGGLE:
+ break;
+
+ case SF_VALUE:
+ case SF_STRING:
+ case SF_TEXT:
+ g_free (arg->default_value.sfa_value);
+ g_free (arg->value.sfa_value);
+ break;
+
+ case SF_ADJUSTMENT:
+ break;
+
+ case SF_FILENAME:
+ case SF_DIRNAME:
+ g_free (arg->default_value.sfa_file.filename);
+ g_free (arg->value.sfa_file.filename);
+ break;
+
+ case SF_FONT:
+ g_free (arg->default_value.sfa_font);
+ g_free (arg->value.sfa_font);
+ break;
+
+ case SF_PALETTE:
+ g_free (arg->default_value.sfa_palette);
+ g_free (arg->value.sfa_palette);
+ break;
+
+ case SF_PATTERN:
+ g_free (arg->default_value.sfa_pattern);
+ g_free (arg->value.sfa_pattern);
+ break;
+
+ case SF_GRADIENT:
+ g_free (arg->default_value.sfa_gradient);
+ g_free (arg->value.sfa_gradient);
+ break;
+
+ case SF_BRUSH:
+ g_free (arg->default_value.sfa_brush.name);
+ g_free (arg->value.sfa_brush.name);
+ break;
+
+ case SF_OPTION:
+ g_slist_free_full (arg->default_value.sfa_option.list,
+ (GDestroyNotify) g_free);
+ break;
+
+ case SF_ENUM:
+ g_free (arg->default_value.sfa_enum.type_name);
+ break;
+ }
+}
+
+/* Reset: copy the default value to current value. */
+void
+script_fu_arg_reset (SFArg *arg, gboolean should_reset_ids)
+{
+ SFArgValue *value = &arg->value;
+ SFArgValue *default_value = &arg->default_value;
+
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ case SF_DRAWABLE:
+ case SF_LAYER:
+ case SF_CHANNEL:
+ case SF_VECTORS:
+ case SF_DISPLAY:
+ if (should_reset_ids)
+ {
+ /* !!! Use field name "sfa_image"; all these cases have same type in union.
+ * The field type is an int, this is an ID.
+ * We can use the same trick to group other cases, below.
+ */
+ value->sfa_image = default_value->sfa_image;
+ }
+
+ break;
+
+ case SF_COLOR:
+ value->sfa_color = default_value->sfa_color;
+ break;
+
+ case SF_TOGGLE:
+ value->sfa_toggle = default_value->sfa_toggle;
+ break;
+
+ case SF_VALUE:
+ case SF_STRING:
+ case SF_TEXT:
+ g_free (value->sfa_value);
+ value->sfa_value = g_strdup (default_value->sfa_value);
+ break;
+
+ case SF_ADJUSTMENT:
+ value->sfa_adjustment.value = default_value->sfa_adjustment.value;
+ break;
+
+ case SF_FILENAME:
+ case SF_DIRNAME:
+ g_free (value->sfa_file.filename);
+ value->sfa_file.filename = g_strdup (default_value->sfa_file.filename);
+ break;
+
+ case SF_FONT:
+ g_free (value->sfa_font);
+ value->sfa_font = g_strdup (default_value->sfa_font);
+ break;
+
+ case SF_PALETTE:
+ g_free (value->sfa_palette);
+ value->sfa_palette = g_strdup (default_value->sfa_palette);
+ break;
+
+ case SF_PATTERN:
+ g_free (value->sfa_pattern);
+ value->sfa_pattern = g_strdup (default_value->sfa_pattern);
+ break;
+
+ case SF_GRADIENT:
+ g_free (value->sfa_gradient);
+ value->sfa_gradient = g_strdup (default_value->sfa_gradient);
+ break;
+
+ case SF_BRUSH:
+ g_free (value->sfa_brush.name);
+ value->sfa_brush.name = g_strdup (default_value->sfa_brush.name);
+ value->sfa_brush.opacity = default_value->sfa_brush.opacity;
+ value->sfa_brush.spacing = default_value->sfa_brush.spacing;
+ value->sfa_brush.paint_mode = default_value->sfa_brush.paint_mode;
+ break;
+
+ case SF_OPTION:
+ value->sfa_option.history = default_value->sfa_option.history;
+ break;
+
+ case SF_ENUM:
+ value->sfa_enum.history = default_value->sfa_enum.history;
+ break;
+ }
+}
+
+/* Return param spec that describes the arg.
+ * Convert instance of SFArg to instance of GParamSpec.
+ *
+ * Used to specify an arg to the PDB proc which this script implements.
+ */
+// FIXME set defaults correctly from arg->default_value.foo.value
+// FIXME set limits correctly
+GParamSpec *
+script_fu_arg_get_param_spec (SFArg *arg,
+ const gchar *name,
+ const gchar *nick)
+{
+ GParamSpec * pspec = NULL;
+
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ pspec = gimp_param_spec_image (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_DRAWABLE:
+ pspec = gimp_param_spec_drawable (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_LAYER:
+ pspec = gimp_param_spec_layer (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_CHANNEL:
+ pspec = gimp_param_spec_channel (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_VECTORS:
+ pspec = gimp_param_spec_vectors (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_DISPLAY:
+ pspec = gimp_param_spec_display (name,
+ nick,
+ arg->label,
+ TRUE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_COLOR:
+ pspec = gimp_param_spec_rgb (name,
+ nick,
+ arg->label,
+ TRUE, NULL,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_TOGGLE:
+ pspec = g_param_spec_boolean (name,
+ nick,
+ arg->label,
+ FALSE,
+ G_PARAM_READWRITE);
+ break;
+
+ case SF_VALUE:
+ case SF_STRING:
+ case SF_TEXT:
+
+ case SF_FONT:
+ case SF_PALETTE:
+ case SF_PATTERN:
+ case SF_BRUSH:
+ case SF_GRADIENT:
+ pspec = g_param_spec_string (name,
+ nick,
+ arg->label,
+ NULL,
+ G_PARAM_READWRITE);
+ break;
+
+
+ case SF_ADJUSTMENT:
+ pspec = g_param_spec_double (name,
+ nick,
+ arg->label,
+ -G_MAXDOUBLE, G_MAXDOUBLE, 0,
+ G_PARAM_READWRITE);
+ break;
+
+ // FIXME GFile
+ case SF_FILENAME:
+ case SF_DIRNAME:
+ pspec = g_param_spec_string (name,
+ nick,
+ arg->label,
+ NULL,
+ G_PARAM_READWRITE |
+ GIMP_PARAM_NO_VALIDATE);
+ break;
+
+ // FIXME SF_ENUM should be g_param_spec_enum( g_type_from_name (arg->default_value.sfa_enum.type_name))
+ case SF_ENUM:
+ case SF_OPTION:
+ pspec = g_param_spec_int (name,
+ nick,
+ arg->label,
+ G_MININT, G_MAXINT, 0,
+ G_PARAM_READWRITE);
+ break;
+ }
+
+ return pspec;
+}
+
+
+/* Append a Scheme representation of the arg value from the given gvalue.
+ * Append to a Scheme text to be interpreted.
+ *
+ * The SFArg only specifies the type,
+ * but the GType held by the GValue must be the same or convertable.
+ *
+ * The repr comes from the value of the GValue, not the value of the SFArg.
+ *
+ * Used when GIMP is calling the PDB procedure implemented by the script,
+ * passing a GValueArray.
+ */
+void
+script_fu_arg_append_repr_from_gvalue (SFArg *arg,
+ GString *result_string,
+ GValue *gvalue)
+{
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ case SF_DRAWABLE:
+ case SF_LAYER:
+ case SF_CHANNEL:
+ case SF_VECTORS:
+ case SF_DISPLAY:
+ {
+ GObject *object = g_value_get_object (gvalue);
+ gint id = -1;
+
+ if (object)
+ g_object_get (object, "id", &id, NULL);
+
+ g_string_append_printf (result_string, "%d", id);
+ }
+ break;
+
+ case SF_COLOR:
+ {
+ GimpRGB color;
+ guchar r, g, b;
+
+ gimp_value_get_rgb (gvalue, &color);
+ gimp_rgb_get_uchar (&color, &r, &g, &b);
+ g_string_append_printf (result_string, "'(%d %d %d)",
+ (gint) r, (gint) g, (gint) b);
+ }
+ break;
+
+ case SF_TOGGLE:
+ g_string_append_printf (result_string, (g_value_get_boolean (gvalue) ?
+ "TRUE" : "FALSE"));
+ break;
+
+ case SF_VALUE:
+ g_string_append (result_string, g_value_get_string (gvalue));
+ break;
+
+ case SF_STRING:
+ case SF_TEXT:
+ case SF_FILENAME:
+ case SF_DIRNAME:
+ {
+ gchar *tmp;
+
+ tmp = script_fu_strescape (g_value_get_string (gvalue));
+ g_string_append_printf (result_string, "\"%s\"", tmp);
+ g_free (tmp);
+ }
+ break;
+
+ case SF_ADJUSTMENT:
+ {
+ gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
+
+ g_ascii_dtostr (buffer, sizeof (buffer), g_value_get_double (gvalue));
+ g_string_append (result_string, buffer);
+ }
+ break;
+
+ case SF_FONT:
+ case SF_PALETTE:
+ case SF_PATTERN:
+ case SF_GRADIENT:
+ case SF_BRUSH:
+ g_string_append_printf (result_string, "\"%s\"", g_value_get_string (gvalue));
+ break;
+
+ case SF_OPTION:
+ case SF_ENUM:
+ g_string_append_printf (result_string, "%d", g_value_get_int (gvalue));
+ break;
+ }
+}
+
+/* Append a Scheme representation of the arg value from self's value.
+ * Append to a Scheme text to be interpreted.
+ *
+ * Used when the PDB procedure implemented by the script is being calling interactively,
+ * after a GUI dialog has written user's choices into self's value.
+ */
+void
+script_fu_arg_append_repr_from_self (SFArg *arg,
+ GString *result_string)
+{
+ SFArgValue *arg_value = &arg->value;
+
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ case SF_DRAWABLE:
+ case SF_LAYER:
+ case SF_CHANNEL:
+ case SF_VECTORS:
+ case SF_DISPLAY:
+ g_string_append_printf (result_string, "%d", arg_value->sfa_image);
+ break;
+
+ case SF_COLOR:
+ {
+ guchar r, g, b;
+
+ gimp_rgb_get_uchar (&arg_value->sfa_color, &r, &g, &b);
+ g_string_append_printf (result_string, "'(%d %d %d)",
+ (gint) r, (gint) g, (gint) b);
+ }
+ break;
+
+ case SF_TOGGLE:
+ g_string_append (result_string, arg_value->sfa_toggle ? "TRUE" : "FALSE");
+ break;
+
+ case SF_VALUE:
+ g_string_append (result_string, arg_value->sfa_value);
+ break;
+
+ case SF_STRING:
+ case SF_TEXT:
+ {
+ gchar *tmp;
+
+ tmp = script_fu_strescape (arg_value->sfa_value);
+ g_string_append_printf (result_string, "\"%s\"", tmp);
+ g_free (tmp);
+ }
+ break;
+
+ case SF_ADJUSTMENT:
+ {
+ gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
+
+ g_ascii_dtostr (buffer, sizeof (buffer),
+ arg_value->sfa_adjustment.value);
+ g_string_append (result_string, buffer);
+ }
+ break;
+
+ case SF_FILENAME:
+ case SF_DIRNAME:
+ {
+ gchar *tmp;
+
+ tmp = script_fu_strescape (arg_value->sfa_file.filename);
+ g_string_append_printf (result_string, "\"%s\"", tmp);
+ g_free (tmp);
+ }
+ break;
+
+ case SF_FONT:
+ g_string_append_printf (result_string, "\"%s\"", arg_value->sfa_font);
+ break;
+
+ case SF_PALETTE:
+ g_string_append_printf (result_string, "\"%s\"", arg_value->sfa_palette);
+ break;
+
+ case SF_PATTERN:
+ g_string_append_printf (result_string, "\"%s\"", arg_value->sfa_pattern);
+ break;
+
+ case SF_GRADIENT:
+ g_string_append_printf (result_string, "\"%s\"", arg_value->sfa_gradient);
+ break;
+
+ case SF_BRUSH:
+ {
+ gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
+
+ g_ascii_dtostr (buffer, sizeof (buffer),
+ arg_value->sfa_brush.opacity);
+ g_string_append_printf (result_string, "'(\"%s\" %s %d %d)",
+ arg_value->sfa_brush.name,
+ buffer,
+ arg_value->sfa_brush.spacing,
+ arg_value->sfa_brush.paint_mode);
+ }
+ break;
+
+ case SF_OPTION:
+ g_string_append_printf (result_string, "%d", arg_value->sfa_option.history);
+ break;
+
+ case SF_ENUM:
+ g_string_append_printf (result_string, "%d", arg_value->sfa_enum.history);
+ break;
+ }
+}
+
+
+/* Array the size of the enum
+ * Counts names generated per SF type per generator session.
+ */
+static gint arg_count[SF_DISPLAY] = { 0, };
+
+void
+script_fu_arg_reset_name_generator (void)
+{
+ for (guint i = 0; i<SF_DISPLAY; i++)
+ arg_count[i] = 0;
+}
+
+/*
+ * Return a unique name, and non-unique nick, for self.
+ *
+ * This is a generator.
+ * Returned name is a canonical name for a GParamSpec, i.e. a property name.
+ * It meets the lexical requirements for a property name.
+ * It is unique among all names returned between resets of the generator.
+ * Thus name meets uniquity for names of properties of one object.
+ *
+ * The name means nothing to human readers of the spec.
+ * The nick is descriptive.
+ *
+ * The returned string is owned by the generator
+ * and is only stable until the next call to the generator.
+ * That is, the caller should copy it (usually by creating a GParamSpec.)
+ */
+void
+script_fu_arg_generate_name_and_nick (SFArg *arg,
+ const gchar **returned_name,
+ const gchar **returned_nick)
+{
+ static gchar numbered_name[64];
+ gchar *name = NULL;
+
+ switch (arg->type)
+ {
+ case SF_IMAGE:
+ name = "image";
+ break;
+
+ case SF_DRAWABLE:
+ name = "drawable";
+ break;
+
+ case SF_LAYER:
+ name = "layer";
+ break;
+
+ case SF_CHANNEL:
+ name = "channel";
+ break;
+
+ case SF_VECTORS:
+ name = "vectors";
+ break;
+
+ case SF_DISPLAY:
+ name = "display";
+ break;
+
+ case SF_COLOR:
+ name = "color";
+ break;
+
+ case SF_TOGGLE:
+ name = "toggle";
+ break;
+
+ case SF_VALUE:
+ name = "value";
+ break;
+
+ case SF_STRING:
+ name = "string";
+ break;
+
+ case SF_TEXT:
+ name = "text";
+ break;
+
+ case SF_ADJUSTMENT:
+ name = "adjustment";
+ break;
+
+ case SF_FILENAME:
+ name = "filename";
+ break;
+
+ case SF_DIRNAME:
+ name = "dirname";
+ break;
+
+ case SF_FONT:
+ name = "font";
+ break;
+
+ case SF_PALETTE:
+ name = "palette";
+ break;
+
+ case SF_PATTERN:
+ name = "pattern";
+ break;
+
+ case SF_BRUSH:
+ name = "brush";
+ break;
+
+ case SF_GRADIENT:
+ name = "gradient";
+ break;
+
+ case SF_OPTION:
+ name = "option";
+ break;
+
+ case SF_ENUM:
+ name = "enum";
+ break;
+ }
+
+ if (arg_count[arg->type] == 0)
+ {
+ g_strlcpy (numbered_name, name, sizeof (numbered_name));
+ }
+ else
+ {
+ g_snprintf (numbered_name, sizeof (numbered_name),
+ "%s-%d", name, arg_count[arg->type] + 1);
+ }
+
+ arg_count[arg->type]++;
+
+ *returned_name = numbered_name;
+
+ /* nick is what the script author said describes the arg */
+ *returned_nick = arg->label;
+}
diff --git a/plug-ins/script-fu/libscriptfu/script-fu-arg.h b/plug-ins/script-fu/libscriptfu/script-fu-arg.h
new file mode 100644
index 0000000000..24f982c9d4
--- /dev/null
+++ b/plug-ins/script-fu/libscriptfu/script-fu-arg.h
@@ -0,0 +1,39 @@
+/* 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 <https://www.gnu.org/licenses/>.
+ */
+
+#ifndef __SCRIPT_FU_ARG_H__
+#define __SCRIPT_FU_ARG_H__
+
+void script_fu_arg_free (SFArg *arg);
+void script_fu_arg_reset (SFArg *arg,
+ gboolean should_reset_ids);
+
+GParamSpec *script_fu_arg_get_param_spec (SFArg *arg,
+ const gchar *name,
+ const gchar *nick);
+void script_fu_arg_append_repr_from_gvalue (SFArg *arg,
+ GString *result_string,
+ GValue *gvalue);
+void script_fu_arg_append_repr_from_self (SFArg *arg,
+ GString *result_string);
+
+void script_fu_arg_reset_name_generator (void);
+void script_fu_arg_generate_name_and_nick (SFArg *arg,
+ const gchar **name,
+ const gchar **nick);
+
+#endif /* __SCRIPT_FU_ARG__ */
diff --git a/plug-ins/script-fu/libscriptfu/script-fu-script.c
b/plug-ins/script-fu/libscriptfu/script-fu-script.c
index c1da3838e5..5a93cdbc27 100644
--- a/plug-ins/script-fu/libscriptfu/script-fu-script.c
+++ b/plug-ins/script-fu/libscriptfu/script-fu-script.c
@@ -25,11 +25,8 @@
#include "tinyscheme/scheme-private.h"
#include "script-fu-types.h"
-
+#include "script-fu-arg.h"
#include "script-fu-script.h"
-#include "script-fu-scripts.h"
-#include "script-fu-utils.h"
-
#include "script-fu-intl.h"
@@ -94,72 +91,7 @@ script_fu_script_free (SFScript *script)
for (i = 0; i < script->n_args; i++)
{
- SFArg *arg = &script->args[i];
-
- g_free (arg->label);
-
- switch (arg->type)
- {
- case SF_IMAGE:
- case SF_DRAWABLE:
- case SF_LAYER:
- case SF_CHANNEL:
- case SF_VECTORS:
- case SF_DISPLAY:
- case SF_COLOR:
- case SF_TOGGLE:
- break;
-
- case SF_VALUE:
- case SF_STRING:
- case SF_TEXT:
- g_free (arg->default_value.sfa_value);
- g_free (arg->value.sfa_value);
- break;
-
- case SF_ADJUSTMENT:
- break;
-
- case SF_FILENAME:
- case SF_DIRNAME:
- g_free (arg->default_value.sfa_file.filename);
- g_free (arg->value.sfa_file.filename);
- break;
-
- case SF_FONT:
- g_free (arg->default_value.sfa_font);
- g_free (arg->value.sfa_font);
- break;
-
- case SF_PALETTE:
- g_free (arg->default_value.sfa_palette);
- g_free (arg->value.sfa_palette);
- break;
-
- case SF_PATTERN:
- g_free (arg->default_value.sfa_pattern);
- g_free (arg->value.sfa_pattern);
- break;
-
- case SF_GRADIENT:
- g_free (arg->default_value.sfa_gradient);
- g_free (arg->value.sfa_gradient);
- break;
-
- case SF_BRUSH:
- g_free (arg->default_value.sfa_brush.name);
- g_free (arg->value.sfa_brush.name);
- break;
-
- case SF_OPTION:
- g_slist_free_full (arg->default_value.sfa_option.list,
- (GDestroyNotify) g_free);
- break;
-
- case SF_ENUM:
- g_free (arg->default_value.sfa_enum.type_name);
- break;
- }
+ script_fu_arg_free (&script->args[i]);
}
g_free (script->args);
@@ -209,8 +141,6 @@ script_fu_script_create_PDB_procedure (GimpPlugIn *plug_in,
{
GimpProcedure *procedure;
const gchar *menu_label = NULL;
- gint arg_count[SF_DISPLAY] = { 0, };
- gint i;
g_debug ("script_fu_script_create_PDB_procedure: %s of type %i", script->name, plug_in_type);
@@ -244,306 +174,19 @@ script_fu_script_create_PDB_procedure (GimpPlugIn *plug_in,
GIMP_RUN_INTERACTIVE,
G_PARAM_READWRITE));
- for (i = 0; i < script->n_args; i++)
+ script_fu_arg_reset_name_generator ();
+ for (gint i = 0; i < script->n_args; i++)
{
GParamSpec *pspec = NULL;
const gchar *name = NULL;
const gchar *nick = NULL;
- gchar numbered_name[64];
- gchar numbered_nick[64];
-
- switch (script->args[i].type)
- {
- case SF_IMAGE:
- name = "image";
- nick = "Image";
- break;
-
- case SF_DRAWABLE:
- name = "drawable";
- nick = "Drawable";
- break;
-
- case SF_LAYER:
- name = "layer";
- nick = "Layer";
- break;
-
- case SF_CHANNEL:
- name = "channel";
- nick = "Channel";
- break;
-
- case SF_VECTORS:
- name = "vectors";
- nick = "Vectors";
- break;
-
- case SF_DISPLAY:
- name = "display";
- nick = "Display";
- break;
-
- case SF_COLOR:
- name = "color";
- nick = "Color";
- break;
-
- case SF_TOGGLE:
- name = "toggle";
- nick = "Toggle";
- break;
-
- case SF_VALUE:
- name = "value";
- nick = "Value";
- break;
-
- case SF_STRING:
- name = "string";
- nick = "String";
- break;
-
- case SF_TEXT:
- name = "text";
- nick = "Text";
- break;
-
- case SF_ADJUSTMENT:
- name = "adjustment";
- nick = "Adjustment";
- break;
-
- case SF_FILENAME:
- name = "filename";
- nick = "Filename";
- break;
-
- case SF_DIRNAME:
- name = "dirname";
- nick = "Dirname";
- break;
-
- case SF_FONT:
- name = "font";
- nick = "Font";
- break;
-
- case SF_PALETTE:
- name = "palette";
- nick = "Palette";
- break;
-
- case SF_PATTERN:
- name = "pattern";
- nick = "Pattern";
- break;
-
- case SF_BRUSH:
- name = "brush";
- nick = "Brush";
- break;
-
- case SF_GRADIENT:
- name = "gradient";
- nick = "Gradient";
- break;
-
- case SF_OPTION:
- name = "option";
- nick = "Option";
- break;
-
- case SF_ENUM:
- name = "enum";
- nick = "Enum";
- break;
- }
-
- if (arg_count[script->args[i].type] == 0)
- {
- g_strlcpy (numbered_name, name, sizeof (numbered_name));
- g_strlcpy (numbered_nick, nick, sizeof (numbered_nick));
- }
- else
- {
- g_snprintf (numbered_name, sizeof (numbered_name),
- "%s-%d", name, arg_count[script->args[i].type] + 1);
- g_snprintf (numbered_nick, sizeof (numbered_nick),
- "%s %d", nick, arg_count[script->args[i].type] + 1);
- }
-
- arg_count[script->args[i].type]++;
-
- switch (script->args[i].type)
- {
- case SF_IMAGE:
- pspec = gimp_param_spec_image (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_DRAWABLE:
- pspec = gimp_param_spec_drawable (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_LAYER:
- pspec = gimp_param_spec_layer (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_CHANNEL:
- pspec = gimp_param_spec_channel (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_VECTORS:
- pspec = gimp_param_spec_vectors (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_DISPLAY:
- pspec = gimp_param_spec_display (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE,
- G_PARAM_READWRITE);
- break;
-
- case SF_COLOR:
- pspec = gimp_param_spec_rgb (numbered_name,
- numbered_nick,
- script->args[i].label,
- TRUE, NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_TOGGLE:
- pspec = g_param_spec_boolean (numbered_name,
- numbered_nick,
- script->args[i].label,
- FALSE,
- G_PARAM_READWRITE);
- break;
-
- case SF_VALUE:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_STRING:
- case SF_TEXT:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_ADJUSTMENT:
- pspec = g_param_spec_double (numbered_name,
- numbered_nick,
- script->args[i].label,
- -G_MAXDOUBLE, G_MAXDOUBLE, 0,
- G_PARAM_READWRITE);
- break;
-
- case SF_FILENAME:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE |
- GIMP_PARAM_NO_VALIDATE);
- break;
-
- case SF_DIRNAME:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE |
- GIMP_PARAM_NO_VALIDATE);
- break;
-
- case SF_FONT:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_PALETTE:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_PATTERN:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_BRUSH:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_GRADIENT:
- pspec = g_param_spec_string (numbered_name,
- numbered_nick,
- script->args[i].label,
- NULL,
- G_PARAM_READWRITE);
- break;
-
- case SF_OPTION:
- pspec = g_param_spec_int (numbered_name,
- numbered_nick,
- script->args[i].label,
- G_MININT, G_MAXINT, 0,
- G_PARAM_READWRITE);
- break;
-
- case SF_ENUM:
- pspec = g_param_spec_int (numbered_name,
- numbered_nick,
- script->args[i].label,
- G_MININT, G_MAXINT, 0,
- G_PARAM_READWRITE);
- break;
- }
+ script_fu_arg_generate_name_and_nick (&script->args[i], &name, &nick);
+ pspec = script_fu_arg_get_param_spec (&script->args[i],
+ name,
+ nick);
gimp_procedure_add_argument (procedure, pspec);
}
-
return procedure;
}
@@ -599,82 +242,7 @@ script_fu_script_reset (SFScript *script,
for (i = 0; i < script->n_args; i++)
{
- SFArgValue *value = &script->args[i].value;
- SFArgValue *default_value = &script->args[i].default_value;
-
- switch (script->args[i].type)
- {
- case SF_IMAGE:
- case SF_DRAWABLE:
- case SF_LAYER:
- case SF_CHANNEL:
- case SF_VECTORS:
- case SF_DISPLAY:
- if (reset_ids)
- value->sfa_image = default_value->sfa_image;
- break;
-
- case SF_COLOR:
- value->sfa_color = default_value->sfa_color;
- break;
-
- case SF_TOGGLE:
- value->sfa_toggle = default_value->sfa_toggle;
- break;
-
- case SF_VALUE:
- case SF_STRING:
- case SF_TEXT:
- g_free (value->sfa_value);
- value->sfa_value = g_strdup (default_value->sfa_value);
- break;
-
- case SF_ADJUSTMENT:
- value->sfa_adjustment.value = default_value->sfa_adjustment.value;
- break;
-
- case SF_FILENAME:
- case SF_DIRNAME:
- g_free (value->sfa_file.filename);
- value->sfa_file.filename = g_strdup (default_value->sfa_file.filename);
- break;
-
- case SF_FONT:
- g_free (value->sfa_font);
- value->sfa_font = g_strdup (default_value->sfa_font);
- break;
-
- case SF_PALETTE:
- g_free (value->sfa_palette);
- value->sfa_palette = g_strdup (default_value->sfa_palette);
- break;
-
- case SF_PATTERN:
- g_free (value->sfa_pattern);
- value->sfa_pattern = g_strdup (default_value->sfa_pattern);
- break;
-
- case SF_GRADIENT:
- g_free (value->sfa_gradient);
- value->sfa_gradient = g_strdup (default_value->sfa_gradient);
- break;
-
- case SF_BRUSH:
- g_free (value->sfa_brush.name);
- value->sfa_brush.name = g_strdup (default_value->sfa_brush.name);
- value->sfa_brush.opacity = default_value->sfa_brush.opacity;
- value->sfa_brush.spacing = default_value->sfa_brush.spacing;
- value->sfa_brush.paint_mode = default_value->sfa_brush.paint_mode;
- break;
-
- case SF_OPTION:
- value->sfa_option.history = default_value->sfa_option.history;
- break;
-
- case SF_ENUM:
- value->sfa_enum.history = default_value->sfa_enum.history;
- break;
- }
+ script_fu_arg_reset (&script->args[i], reset_ids);
}
}
@@ -737,109 +305,9 @@ script_fu_script_get_command (SFScript *script)
for (i = 0; i < script->n_args; i++)
{
- SFArgValue *arg_value = &script->args[i].value;
-
g_string_append_c (s, ' ');
- switch (script->args[i].type)
- {
- case SF_IMAGE:
- case SF_DRAWABLE:
- case SF_LAYER:
- case SF_CHANNEL:
- case SF_VECTORS:
- case SF_DISPLAY:
- g_string_append_printf (s, "%d", arg_value->sfa_image);
- break;
-
- case SF_COLOR:
- {
- guchar r, g, b;
-
- gimp_rgb_get_uchar (&arg_value->sfa_color, &r, &g, &b);
- g_string_append_printf (s, "'(%d %d %d)",
- (gint) r, (gint) g, (gint) b);
- }
- break;
-
- case SF_TOGGLE:
- g_string_append (s, arg_value->sfa_toggle ? "TRUE" : "FALSE");
- break;
-
- case SF_VALUE:
- g_string_append (s, arg_value->sfa_value);
- break;
-
- case SF_STRING:
- case SF_TEXT:
- {
- gchar *tmp;
-
- tmp = script_fu_strescape (arg_value->sfa_value);
- g_string_append_printf (s, "\"%s\"", tmp);
- g_free (tmp);
- }
- break;
-
- case SF_ADJUSTMENT:
- {
- gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
-
- g_ascii_dtostr (buffer, sizeof (buffer),
- arg_value->sfa_adjustment.value);
- g_string_append (s, buffer);
- }
- break;
-
- case SF_FILENAME:
- case SF_DIRNAME:
- {
- gchar *tmp;
-
- tmp = script_fu_strescape (arg_value->sfa_file.filename);
- g_string_append_printf (s, "\"%s\"", tmp);
- g_free (tmp);
- }
- break;
-
- case SF_FONT:
- g_string_append_printf (s, "\"%s\"", arg_value->sfa_font);
- break;
-
- case SF_PALETTE:
- g_string_append_printf (s, "\"%s\"", arg_value->sfa_palette);
- break;
-
- case SF_PATTERN:
- g_string_append_printf (s, "\"%s\"", arg_value->sfa_pattern);
- break;
-
- case SF_GRADIENT:
- g_string_append_printf (s, "\"%s\"", arg_value->sfa_gradient);
- break;
-
- case SF_BRUSH:
- {
- gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
-
- g_ascii_dtostr (buffer, sizeof (buffer),
- arg_value->sfa_brush.opacity);
- g_string_append_printf (s, "'(\"%s\" %s %d %d)",
- arg_value->sfa_brush.name,
- buffer,
- arg_value->sfa_brush.spacing,
- arg_value->sfa_brush.paint_mode);
- }
- break;
-
- case SF_OPTION:
- g_string_append_printf (s, "%d", arg_value->sfa_option.history);
- break;
-
- case SF_ENUM:
- g_string_append_printf (s, "%d", arg_value->sfa_enum.history);
- break;
- }
+ script_fu_arg_append_repr_from_self (&script->args[i], s);
}
g_string_append_c (s, ')');
@@ -865,81 +333,9 @@ script_fu_script_get_command_from_params (SFScript *script,
g_string_append_c (s, ' ');
- switch (script->args[i].type)
- {
- case SF_IMAGE:
- case SF_DRAWABLE:
- case SF_LAYER:
- case SF_CHANNEL:
- case SF_VECTORS:
- case SF_DISPLAY:
- {
- GObject *object = g_value_get_object (value);
- gint id = -1;
-
- if (object)
- g_object_get (object, "id", &id, NULL);
-
- g_string_append_printf (s, "%d", id);
- }
- break;
-
- case SF_COLOR:
- {
- GimpRGB color;
- guchar r, g, b;
-
- gimp_value_get_rgb (value, &color);
- gimp_rgb_get_uchar (&color, &r, &g, &b);
- g_string_append_printf (s, "'(%d %d %d)",
- (gint) r, (gint) g, (gint) b);
- }
- break;
-
- case SF_TOGGLE:
- g_string_append_printf (s, (g_value_get_boolean (value) ?
- "TRUE" : "FALSE"));
- break;
-
- case SF_VALUE:
- g_string_append (s, g_value_get_string (value));
- break;
-
- case SF_STRING:
- case SF_TEXT:
- case SF_FILENAME:
- case SF_DIRNAME:
- {
- gchar *tmp;
-
- tmp = script_fu_strescape (g_value_get_string (value));
- g_string_append_printf (s, "\"%s\"", tmp);
- g_free (tmp);
- }
- break;
-
- case SF_ADJUSTMENT:
- {
- gchar buffer[G_ASCII_DTOSTR_BUF_SIZE];
-
- g_ascii_dtostr (buffer, sizeof (buffer), g_value_get_double (value));
- g_string_append (s, buffer);
- }
- break;
-
- case SF_FONT:
- case SF_PALETTE:
- case SF_PATTERN:
- case SF_GRADIENT:
- case SF_BRUSH:
- g_string_append_printf (s, "\"%s\"", g_value_get_string (value));
- break;
-
- case SF_OPTION:
- case SF_ENUM:
- g_string_append_printf (s, "%d", g_value_get_int (value));
- break;
- }
+ script_fu_arg_append_repr_from_gvalue (&script->args[i],
+ s,
+ value);
}
g_string_append_c (s, ')');
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
