plug-ins/scheme-wrapper: Use GIR for enum values

This allows our script-fu plugins to use the GIMP enum values, just like
all our other plug-ins know them.

In other words:

* Names are consistent with those of other plug-ins
* Introspectable enums are automatically added as they are added to the
  introspection file, without even needing a recompile
* No need to keep track of our enum types anymore, as that is just a
  redundant implementation of introspection in practice. This in turn
  will let us simplify some of the pdb code
This commit is contained in:
Niels De Graef 2021-11-30 11:38:10 +01:00
parent 00415bed6a
commit 01e960e98e
5 changed files with 104 additions and 57 deletions

View File

@ -375,6 +375,7 @@ gio_specific = dependency(gio_specific_name)
glib_minver = '2.70.0' glib_minver = '2.70.0'
glib = dependency('glib-2.0', version: '>='+glib_minver) glib = dependency('glib-2.0', version: '>='+glib_minver)
gi = dependency('gobject-introspection-1.0')
conf.set('G_DISABLE_DEPRECATED', glib.version().version_compare('>=2.57')) conf.set('G_DISABLE_DEPRECATED', glib.version().version_compare('>=2.57'))

View File

@ -34,6 +34,7 @@ AM_CPPFLAGS = \
-I$(top_srcdir) \ -I$(top_srcdir) \
$(GTK_CFLAGS) \ $(GTK_CFLAGS) \
$(GEGL_CFLAGS) \ $(GEGL_CFLAGS) \
$(INTROSPECTION_CFLAGS) \
-I$(includedir) \ -I$(includedir) \
-I$(srcdir)/libscriptfu \ -I$(srcdir)/libscriptfu \
-DG_LOG_DOMAIN=\"scriptfu\" -DG_LOG_DOMAIN=\"scriptfu\"
@ -80,6 +81,7 @@ script_fu_LDADD = \
$(GTK_LIBS) \ $(GTK_LIBS) \
$(RT_LIBS) \ $(RT_LIBS) \
$(INTLLIBS) \ $(INTLLIBS) \
$(INTROSPECTION_LIBS) \
$(script_fu_RC) $(script_fu_RC)

View File

@ -54,6 +54,7 @@ libscriptfu = library('gimp-scriptfu-'+ gimp_api_version,
dependencies: [ dependencies: [
libgimpui_dep, libgimpui_dep,
math, math,
gi,
], ],
link_whole: [ link_whole: [
scriptfu_tinyscheme, scriptfu_tinyscheme,

View File

@ -24,6 +24,8 @@
#include <glib/gstdio.h> #include <glib/gstdio.h>
#include <girepository.h>
#include <gtk/gtk.h> #include <gtk/gtk.h>
#include "libgimp/gimp.h" #include "libgimp/gimp.h"
@ -48,16 +50,16 @@
#undef cons #undef cons
static void ts_init_constants (scheme *sc); static void ts_init_constants (scheme *sc,
static void ts_init_enum (scheme *sc, GIRepository *repo);
GType enum_type); static void ts_init_enums (scheme *sc,
GIRepository *repo,
const char *namespace);
static void ts_define_procedure (scheme *sc, static void ts_define_procedure (scheme *sc,
const gchar *symbol_name, const gchar *symbol_name,
TsWrapperFunc func); TsWrapperFunc func);
static void ts_init_procedures (scheme *sc, static void ts_init_procedures (scheme *sc,
gboolean register_scipts); gboolean register_scipts);
static void convert_string (gchar *str);
static pointer script_fu_marshal_procedure_call (scheme *sc, static pointer script_fu_marshal_procedure_call (scheme *sc,
pointer a, pointer a,
gboolean permissive, gboolean permissive,
@ -187,6 +189,10 @@ void
tinyscheme_init (GList *path, tinyscheme_init (GList *path,
gboolean register_scripts) gboolean register_scripts)
{ {
GIRepository *repo;
GITypelib *typelib;
GError *error = NULL;
/* init the interpreter */ /* init the interpreter */
if (! scheme_init (&sc)) if (! scheme_init (&sc))
{ {
@ -202,8 +208,18 @@ tinyscheme_init (GList *path,
init_ftx (&sc); init_ftx (&sc);
script_fu_regex_init (&sc); script_fu_regex_init (&sc);
/* Fetch the typelib */
repo = g_irepository_get_default ();
typelib = g_irepository_require (repo, "Gimp", NULL, 0, &error);
if (!typelib)
{
g_warning ("%s", error->message);
g_clear_error (&error);
return;
}
/* register in the interpreter the gimp functions and types. */ /* register in the interpreter the gimp functions and types. */
ts_init_constants (&sc); ts_init_constants (&sc, repo);
ts_init_procedures (&sc, register_scripts); ts_init_procedures (&sc, register_scripts);
if (path) if (path)
@ -348,13 +364,11 @@ ts_register_post_command_callback (TsCallbackFunc callback)
* gimp functions and types against the scheme interpreter. * gimp functions and types against the scheme interpreter.
*/ */
static void static void
ts_init_constants (scheme *sc) ts_init_constants (scheme *sc,
GIRepository *repo)
{ {
const gchar **enum_type_names; int i;
gint n_enum_type_names;
gint i;
pointer symbol; pointer symbol;
GQuark quark;
symbol = sc->vptr->mk_symbol (sc, "gimp-directory"); symbol = sc->vptr->mk_symbol (sc, "gimp-directory");
sc->vptr->scheme_define (sc, sc->global_env, symbol, sc->vptr->scheme_define (sc, sc->global_env, symbol,
@ -381,21 +395,8 @@ ts_init_constants (scheme *sc)
sc->vptr->mk_string (sc, gimp_sysconf_directory ())); sc->vptr->mk_string (sc, gimp_sysconf_directory ()));
sc->vptr->setimmutable (symbol); sc->vptr->setimmutable (symbol);
enum_type_names = gimp_enums_get_type_names (&n_enum_type_names); ts_init_enums (sc, repo, "Gimp");
quark = g_quark_from_static_string ("gimp-compat-enum"); ts_init_enums (sc, repo, "Gegl");
for (i = 0; i < n_enum_type_names; i++)
{
const gchar *enum_name = enum_type_names[i];
GType enum_type = g_type_from_name (enum_name);
ts_init_enum (sc, enum_type);
enum_type = (GType) g_type_get_qdata (enum_type, quark);
if (enum_type)
ts_init_enum (sc, enum_type);
}
/* Constants used in the register block of scripts */ /* Constants used in the register block of scripts */
for (i = 0; script_constants[i].name != NULL; ++i) for (i = 0; script_constants[i].name != NULL; ++i)
@ -438,31 +439,82 @@ ts_init_constants (scheme *sc)
static void static void
ts_init_enum (scheme *sc, ts_init_enum (scheme *sc,
GType enum_type) GIEnumInfo *info,
const char *namespace)
{ {
GEnumClass *enum_class = g_type_class_ref (enum_type); int n_values;
GEnumValue *value;
for (value = enum_class->values; value->value_name; value++) n_values = g_enum_info_get_n_values ((GIEnumInfo *) info);
for (int j = 0; j < n_values; j++)
{ {
if (g_str_has_prefix (value->value_name, "GIMP_")) GIValueInfo *value_info;
{ const char *c_identifier;
gchar *scheme_name; char *scheme_name;
int int_value;
pointer symbol; pointer symbol;
scheme_name = g_strdup (value->value_name + strlen ("GIMP_")); value_info = g_enum_info_get_value (info, j);
convert_string (scheme_name);
/* Get name & value. Normally, we would use the actual name of the
* GIBaseInfo here, but that would break bw-compatibility */
c_identifier = g_base_info_get_attribute ((GIBaseInfo *) value_info, "c:identifier");
if (c_identifier == NULL)
{
g_warning ("Problem in the GIR file: enum value without \"c:identifier\"!");
g_base_info_unref ((GIBaseInfo *) value_info);
continue;
}
/* Scheme-ify the name */
if (g_strcmp0 (namespace, "Gimp") == 0)
{
/* Skip the GIMP prefix for GIMP enums */
if (g_str_has_prefix (c_identifier, "GIMP_"))
c_identifier += strlen ("GIMP_");
}
else
{
/* Other namespaces: skip non-prefixed symbols, to prevent clashes */
if (g_ascii_strncasecmp (c_identifier, namespace, strlen (namespace)) != 0)
{
g_base_info_unref ((GIBaseInfo *) value_info);
continue;
}
}
scheme_name = g_strdelimit (g_strdup (c_identifier), "_", '-');
int_value = g_value_info_get_value (value_info);
/* Register the symbol */
symbol = sc->vptr->mk_symbol (sc, scheme_name); symbol = sc->vptr->mk_symbol (sc, scheme_name);
sc->vptr->scheme_define (sc, sc->global_env, symbol, sc->vptr->scheme_define (sc, sc->global_env, symbol,
sc->vptr->mk_integer (sc, value->value)); sc->vptr->mk_integer (sc, int_value));
sc->vptr->setimmutable (symbol); sc->vptr->setimmutable (symbol);
g_free (scheme_name); g_free (scheme_name);
g_base_info_unref ((GIBaseInfo *) value_info);
} }
}
static void
ts_init_enums (scheme *sc,
GIRepository *repo,
const char *namespace)
{
int i, n_infos;
n_infos = g_irepository_get_n_infos (repo, namespace);
for (i = 0; i < n_infos; i++)
{
GIBaseInfo *info;
info = g_irepository_get_info (repo, namespace, i);
if (GI_IS_ENUM_INFO (info))
{
ts_init_enum (sc, (GIEnumInfo *) info, namespace);
} }
g_type_class_unref (enum_class); g_base_info_unref (info);
}
} }
/* Define a symbol into interpreter state, /* Define a symbol into interpreter state,
@ -578,16 +630,6 @@ ts_load_file (const gchar *dirname,
return FALSE; return FALSE;
} }
static void
convert_string (gchar *str)
{
while (*str)
{
if (*str == '_') *str = '-';
str++;
}
}
/* Called by the Scheme interpreter on calls to GIMP PDB procedures */ /* Called by the Scheme interpreter on calls to GIMP PDB procedures */
static pointer static pointer
script_fu_marshal_procedure_call (scheme *sc, script_fu_marshal_procedure_call (scheme *sc,

View File

@ -50,6 +50,7 @@ executable(executable_name,
dependencies: [ dependencies: [
libgimpui_dep, libgimpui_dep,
math, math,
gi,
], ],
c_args: [ c_args: [
'-DG_LOG_DOMAIN="scriptfu"', '-DG_LOG_DOMAIN="scriptfu"',