gimp/app/plug-in/plug-in-rc.c

1539 lines
49 KiB
C

/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* plug-in-rc.c
* Copyright (C) 2001 Sven Neumann <sven@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 <gdk-pixbuf/gdk-pixbuf.h>
#include <gegl.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpbase/gimpprotocol.h"
#include "libgimpconfig/gimpconfig.h"
#include "libgimp/gimpgpparams.h"
#include "plug-in-types.h"
#include "core/gimp.h"
#include "gimpplugindef.h"
#include "gimppluginprocedure.h"
#include "plug-in-rc.h"
#include "gimp-intl.h"
#define PLUG_IN_RC_FILE_VERSION 14
/*
* All deserialize functions return G_TOKEN_LEFT_PAREN on success,
* or the GTokenType they would have expected but didn't get,
* or G_TOKEN_ERROR if the function already set an error itself.
*/
static GTokenType plug_in_def_deserialize (Gimp *gimp,
GScanner *scanner,
GSList **plug_in_defs);
static GTokenType plug_in_procedure_deserialize (GScanner *scanner,
Gimp *gimp,
GFile *file,
GimpPlugInProcedure **proc);
static GTokenType plug_in_menu_path_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc);
static GTokenType plug_in_icon_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc);
static GTokenType plug_in_file_or_batch_proc_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc);
static GTokenType plug_in_proc_arg_deserialize (GScanner *scanner,
Gimp *gimp,
GimpProcedure *procedure,
gboolean return_value);
static GTokenType plug_in_help_def_deserialize (GScanner *scanner,
GimpPlugInDef *plug_in_def);
static GTokenType plug_in_has_init_deserialize (GScanner *scanner,
GimpPlugInDef *plug_in_def);
enum
{
PROTOCOL_VERSION = 1,
FILE_VERSION,
PLUG_IN_DEF,
PROC_DEF,
HELP_DEF,
HAS_INIT,
PROC_ARG,
MENU_PATH,
ICON,
LOAD_PROC,
SAVE_PROC,
EXTENSIONS,
PREFIXES,
MAGICS,
PRIORITY,
MIME_TYPES,
HANDLES_REMOTE,
HANDLES_RAW,
HANDLES_VECTOR,
THUMB_LOADER,
BATCH_INTERPRETER,
};
GSList *
plug_in_rc_parse (Gimp *gimp,
GFile *file,
GError **error)
{
GScanner *scanner;
GEnumClass *enum_class;
GSList *plug_in_defs = NULL;
gint protocol_version = GIMP_PROTOCOL_VERSION;
gint file_version = PLUG_IN_RC_FILE_VERSION;
GTokenType token;
g_return_val_if_fail (GIMP_IS_GIMP (gimp), NULL);
g_return_val_if_fail (G_IS_FILE (file), NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
scanner = gimp_scanner_new_file (file, error);
if (! scanner)
return NULL;
enum_class = g_type_class_ref (GIMP_TYPE_ICON_TYPE);
g_scanner_scope_add_symbol (scanner, 0,
"protocol-version",
GINT_TO_POINTER (PROTOCOL_VERSION));
g_scanner_scope_add_symbol (scanner, 0,
"file-version",
GINT_TO_POINTER (FILE_VERSION));
g_scanner_scope_add_symbol (scanner, 0,
"plug-in-def", GINT_TO_POINTER (PLUG_IN_DEF));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"proc-def", GINT_TO_POINTER (PROC_DEF));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"help-def", GINT_TO_POINTER (HELP_DEF));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"has-init", GINT_TO_POINTER (HAS_INIT));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"proc-arg", GINT_TO_POINTER (PROC_ARG));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"menu-path", GINT_TO_POINTER (MENU_PATH));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"icon", GINT_TO_POINTER (ICON));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"load-proc", GINT_TO_POINTER (LOAD_PROC));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"save-proc", GINT_TO_POINTER (SAVE_PROC));
g_scanner_scope_add_symbol (scanner, PLUG_IN_DEF,
"batch-interpreter", GINT_TO_POINTER (BATCH_INTERPRETER));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"extensions", GINT_TO_POINTER (EXTENSIONS));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"prefixes", GINT_TO_POINTER (PREFIXES));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"magics", GINT_TO_POINTER (MAGICS));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"priority", GINT_TO_POINTER (PRIORITY));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"mime-types", GINT_TO_POINTER (MIME_TYPES));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"handles-remote", GINT_TO_POINTER (HANDLES_REMOTE));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"handles-raw", GINT_TO_POINTER (HANDLES_RAW));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"handles-vector", GINT_TO_POINTER (HANDLES_VECTOR));
g_scanner_scope_add_symbol (scanner, LOAD_PROC,
"thumb-loader", GINT_TO_POINTER (THUMB_LOADER));
g_scanner_scope_add_symbol (scanner, SAVE_PROC,
"extensions", GINT_TO_POINTER (EXTENSIONS));
g_scanner_scope_add_symbol (scanner, SAVE_PROC,
"prefixes", GINT_TO_POINTER (PREFIXES));
g_scanner_scope_add_symbol (scanner, SAVE_PROC,
"priority", GINT_TO_POINTER (PRIORITY));
g_scanner_scope_add_symbol (scanner, SAVE_PROC,
"mime-types", GINT_TO_POINTER (MIME_TYPES));
g_scanner_scope_add_symbol (scanner, SAVE_PROC,
"handles-remote", GINT_TO_POINTER (HANDLES_REMOTE));
token = G_TOKEN_LEFT_PAREN;
while (protocol_version == GIMP_PROTOCOL_VERSION &&
file_version == PLUG_IN_RC_FILE_VERSION &&
g_scanner_peek_next_token (scanner) == token)
{
token = g_scanner_get_next_token (scanner);
switch (token)
{
case G_TOKEN_LEFT_PAREN:
token = G_TOKEN_SYMBOL;
break;
case G_TOKEN_SYMBOL:
switch (GPOINTER_TO_INT (scanner->value.v_symbol))
{
case PROTOCOL_VERSION:
token = G_TOKEN_INT;
if (gimp_scanner_parse_int (scanner, &protocol_version))
token = G_TOKEN_RIGHT_PAREN;
break;
case FILE_VERSION:
token = G_TOKEN_INT;
if (gimp_scanner_parse_int (scanner, &file_version))
token = G_TOKEN_RIGHT_PAREN;
break;
case PLUG_IN_DEF:
g_scanner_set_scope (scanner, PLUG_IN_DEF);
token = plug_in_def_deserialize (gimp, scanner, &plug_in_defs);
g_scanner_set_scope (scanner, 0);
break;
default:
break;
}
break;
case G_TOKEN_RIGHT_PAREN:
token = G_TOKEN_LEFT_PAREN;
break;
default: /* do nothing */
break;
}
}
if (protocol_version != GIMP_PROTOCOL_VERSION ||
file_version != PLUG_IN_RC_FILE_VERSION ||
token != G_TOKEN_LEFT_PAREN)
{
if (protocol_version != GIMP_PROTOCOL_VERSION)
{
g_set_error (error,
GIMP_CONFIG_ERROR, GIMP_CONFIG_ERROR_VERSION,
_("Skipping '%s': wrong GIMP protocol version."),
gimp_file_get_utf8_name (file));
}
else if (file_version != PLUG_IN_RC_FILE_VERSION)
{
g_set_error (error,
GIMP_CONFIG_ERROR, GIMP_CONFIG_ERROR_VERSION,
_("Skipping '%s': wrong pluginrc file format version."),
gimp_file_get_utf8_name (file));
}
else if (token != G_TOKEN_ERROR)
{
g_scanner_get_next_token (scanner);
g_scanner_unexp_token (scanner, token, NULL, NULL, NULL,
_("fatal parse error"), TRUE);
}
g_slist_free_full (plug_in_defs, (GDestroyNotify) g_object_unref);
plug_in_defs = NULL;
}
g_type_class_unref (enum_class);
gimp_scanner_unref (scanner);
return g_slist_reverse (plug_in_defs);
}
static GTokenType
plug_in_def_deserialize (Gimp *gimp,
GScanner *scanner,
GSList **plug_in_defs)
{
GimpPlugInDef *plug_in_def;
GimpPlugInProcedure *proc = NULL;
gchar *path;
GFile *file;
gint64 mtime;
GTokenType token;
GError *error = NULL;
if (! gimp_scanner_parse_string (scanner, &path))
return G_TOKEN_STRING;
if (! (path && *path))
{
g_scanner_error (scanner, "plug-in filename is empty");
return G_TOKEN_ERROR;
}
file = gimp_file_new_for_config_path (path, &error);
g_free (path);
if (! file)
{
g_scanner_error (scanner,
"unable to parse plug-in filename: %s",
error->message);
g_clear_error (&error);
return G_TOKEN_ERROR;
}
plug_in_def = gimp_plug_in_def_new (file);
g_object_unref (file);
if (! gimp_scanner_parse_int64 (scanner, &mtime))
{
g_object_unref (plug_in_def);
return G_TOKEN_INT;
}
plug_in_def->mtime = mtime;
token = G_TOKEN_LEFT_PAREN;
while (g_scanner_peek_next_token (scanner) == token)
{
token = g_scanner_get_next_token (scanner);
switch (token)
{
case G_TOKEN_LEFT_PAREN:
token = G_TOKEN_SYMBOL;
break;
case G_TOKEN_SYMBOL:
switch (GPOINTER_TO_INT (scanner->value.v_symbol))
{
case PROC_DEF:
token = plug_in_procedure_deserialize (scanner, gimp,
plug_in_def->file,
&proc);
if (token == G_TOKEN_LEFT_PAREN)
gimp_plug_in_def_add_procedure (plug_in_def, proc);
if (proc)
g_object_unref (proc);
break;
case HELP_DEF:
token = plug_in_help_def_deserialize (scanner, plug_in_def);
break;
case HAS_INIT:
token = plug_in_has_init_deserialize (scanner, plug_in_def);
break;
default:
break;
}
break;
case G_TOKEN_RIGHT_PAREN:
token = G_TOKEN_LEFT_PAREN;
break;
default:
break;
}
}
if (token == G_TOKEN_LEFT_PAREN)
{
token = G_TOKEN_RIGHT_PAREN;
if (gimp_scanner_parse_token (scanner, token))
{
*plug_in_defs = g_slist_prepend (*plug_in_defs, plug_in_def);
return G_TOKEN_LEFT_PAREN;
}
}
g_object_unref (plug_in_def);
return token;
}
static GTokenType
plug_in_procedure_deserialize (GScanner *scanner,
Gimp *gimp,
GFile *file,
GimpPlugInProcedure **proc)
{
GimpProcedure *procedure;
GTokenType token;
gchar *str;
gint proc_type;
gint n_args;
gint n_return_vals;
gint n_menu_paths;
gint sensitivity_mask;
gint i;
if (! gimp_scanner_parse_string (scanner, &str))
return G_TOKEN_STRING;
if (! (str && *str))
{
g_scanner_error (scanner, "procedure name is empty");
return G_TOKEN_ERROR;
}
if (! gimp_scanner_parse_int (scanner, &proc_type))
{
g_free (str);
return G_TOKEN_INT;
}
if (proc_type != GIMP_PDB_PROC_TYPE_PLUGIN &&
proc_type != GIMP_PDB_PROC_TYPE_PERSISTENT)
{
g_free (str);
g_scanner_error (scanner, "procedure type %d is out of range",
proc_type);
return G_TOKEN_ERROR;
}
procedure = gimp_plug_in_procedure_new (proc_type, file);
*proc = GIMP_PLUG_IN_PROCEDURE (procedure);
gimp_object_take_name (GIMP_OBJECT (procedure), str);
if (! gimp_scanner_parse_string (scanner, &procedure->blurb))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &procedure->help))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &procedure->authors))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &procedure->copyright))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &procedure->date))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &(*proc)->menu_label))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_int (scanner, &n_menu_paths))
return G_TOKEN_INT;
for (i = 0; i < n_menu_paths; i++)
{
token = plug_in_menu_path_deserialize (scanner, *proc);
if (token != G_TOKEN_LEFT_PAREN)
return token;
}
token = plug_in_icon_deserialize (scanner, *proc);
if (token != G_TOKEN_LEFT_PAREN)
return token;
token = plug_in_file_or_batch_proc_deserialize (scanner, *proc);
if (token != G_TOKEN_LEFT_PAREN)
return token;
if (! gimp_scanner_parse_string (scanner, &str))
return G_TOKEN_STRING;
gimp_plug_in_procedure_set_image_types (*proc, str);
g_free (str);
if (! gimp_scanner_parse_int (scanner, &sensitivity_mask))
return G_TOKEN_INT;
gimp_plug_in_procedure_set_sensitivity_mask (*proc, sensitivity_mask);
if (! gimp_scanner_parse_int (scanner, (gint *) &n_args))
return G_TOKEN_INT;
if (! gimp_scanner_parse_int (scanner, (gint *) &n_return_vals))
return G_TOKEN_INT;
for (i = 0; i < n_args; i++)
{
token = plug_in_proc_arg_deserialize (scanner, gimp, procedure, FALSE);
if (token != G_TOKEN_LEFT_PAREN)
return token;
}
for (i = 0; i < n_return_vals; i++)
{
token = plug_in_proc_arg_deserialize (scanner, gimp, procedure, TRUE);
if (token != G_TOKEN_LEFT_PAREN)
return token;
}
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
return G_TOKEN_LEFT_PAREN;
}
static GTokenType
plug_in_menu_path_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc)
{
gchar *menu_path;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_LEFT_PAREN))
return G_TOKEN_LEFT_PAREN;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_SYMBOL) ||
GPOINTER_TO_INT (scanner->value.v_symbol) != MENU_PATH)
return G_TOKEN_SYMBOL;
if (! gimp_scanner_parse_string (scanner, &menu_path))
return G_TOKEN_STRING;
proc->menu_paths = g_list_append (proc->menu_paths, menu_path);
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
return G_TOKEN_LEFT_PAREN;
}
static GTokenType
plug_in_icon_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc)
{
GEnumClass *enum_class;
GEnumValue *enum_value;
GimpIconType icon_type;
gint icon_data_length;
gchar *icon_name;
guint8 *icon_data;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_LEFT_PAREN))
return G_TOKEN_LEFT_PAREN;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_SYMBOL) ||
GPOINTER_TO_INT (scanner->value.v_symbol) != ICON)
return G_TOKEN_SYMBOL;
enum_class = g_type_class_peek (GIMP_TYPE_ICON_TYPE);
switch (g_scanner_peek_next_token (scanner))
{
case G_TOKEN_IDENTIFIER:
g_scanner_get_next_token (scanner);
enum_value = g_enum_get_value_by_nick (G_ENUM_CLASS (enum_class),
scanner->value.v_identifier);
if (!enum_value)
enum_value = g_enum_get_value_by_name (G_ENUM_CLASS (enum_class),
scanner->value.v_identifier);
if (!enum_value)
{
g_scanner_error (scanner,
_("invalid value '%s' for icon type"),
scanner->value.v_identifier);
return G_TOKEN_NONE;
}
break;
case G_TOKEN_INT:
g_scanner_get_next_token (scanner);
enum_value = g_enum_get_value (enum_class,
(gint) scanner->value.v_int64);
if (!enum_value)
{
g_scanner_error (scanner,
_("invalid value '%ld' for icon type"),
(glong) scanner->value.v_int64);
return G_TOKEN_NONE;
}
break;
default:
return G_TOKEN_IDENTIFIER;
}
icon_type = enum_value->value;
if (! gimp_scanner_parse_int (scanner, &icon_data_length))
return G_TOKEN_INT;
switch (icon_type)
{
case GIMP_ICON_TYPE_ICON_NAME:
case GIMP_ICON_TYPE_IMAGE_FILE:
icon_data_length = -1;
if (! gimp_scanner_parse_string_no_validate (scanner, &icon_name))
return G_TOKEN_STRING;
icon_data = (guint8 *) icon_name;
break;
case GIMP_ICON_TYPE_PIXBUF:
if (icon_data_length < 0)
return G_TOKEN_STRING;
if (! gimp_scanner_parse_data (scanner, icon_data_length, &icon_data))
return G_TOKEN_STRING;
break;
}
gimp_plug_in_procedure_take_icon (proc, icon_type,
icon_data, icon_data_length,
NULL);
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
return G_TOKEN_LEFT_PAREN;
}
static GTokenType
plug_in_file_or_batch_proc_deserialize (GScanner *scanner,
GimpPlugInProcedure *proc)
{
GTokenType token;
gint symbol;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_LEFT_PAREN))
return G_TOKEN_LEFT_PAREN;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_SYMBOL))
return G_TOKEN_SYMBOL;
symbol = GPOINTER_TO_INT (scanner->value.v_symbol);
if (symbol != LOAD_PROC && symbol != SAVE_PROC && symbol != BATCH_INTERPRETER)
return G_TOKEN_SYMBOL;
if (symbol == BATCH_INTERPRETER)
{
gchar *interpreter_name;
if (! gimp_scanner_parse_string (scanner, &interpreter_name))
return G_TOKEN_STRING;
gimp_plug_in_procedure_set_batch_interpreter (proc, interpreter_name);
g_free (interpreter_name);
}
else
{
proc->file_proc = TRUE;
g_scanner_set_scope (scanner, symbol);
while (g_scanner_peek_next_token (scanner) == G_TOKEN_LEFT_PAREN)
{
token = g_scanner_get_next_token (scanner);
if (token != G_TOKEN_LEFT_PAREN)
return token;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_SYMBOL))
return G_TOKEN_SYMBOL;
symbol = GPOINTER_TO_INT (scanner->value.v_symbol);
switch (symbol)
{
case EXTENSIONS:
{
gchar *extensions;
if (! gimp_scanner_parse_string (scanner, &extensions))
return G_TOKEN_STRING;
g_free (proc->extensions);
proc->extensions = extensions;
}
break;
case PREFIXES:
{
gchar *prefixes;
if (! gimp_scanner_parse_string (scanner, &prefixes))
return G_TOKEN_STRING;
g_free (proc->prefixes);
proc->prefixes = prefixes;
}
break;
case MAGICS:
{
gchar *magics;
if (! gimp_scanner_parse_string_no_validate (scanner, &magics))
return G_TOKEN_STRING;
g_free (proc->magics);
proc->magics = magics;
}
break;
case PRIORITY:
{
gint priority;
if (! gimp_scanner_parse_int (scanner, &priority))
return G_TOKEN_INT;
gimp_plug_in_procedure_set_priority (proc, priority);
}
break;
case MIME_TYPES:
{
gchar *mime_types;
if (! gimp_scanner_parse_string (scanner, &mime_types))
return G_TOKEN_STRING;
gimp_plug_in_procedure_set_mime_types (proc, mime_types);
g_free (mime_types);
}
break;
case HANDLES_REMOTE:
gimp_plug_in_procedure_set_handles_remote (proc);
break;
case HANDLES_RAW:
gimp_plug_in_procedure_set_handles_raw (proc);
break;
case HANDLES_VECTOR:
gimp_plug_in_procedure_set_handles_vector (proc);
break;
case THUMB_LOADER:
{
gchar *thumb_loader;
if (! gimp_scanner_parse_string (scanner, &thumb_loader))
return G_TOKEN_STRING;
gimp_plug_in_procedure_set_thumb_loader (proc, thumb_loader);
g_free (thumb_loader);
}
break;
default:
return G_TOKEN_SYMBOL;
}
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
}
}
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
g_scanner_set_scope (scanner, PLUG_IN_DEF);
return G_TOKEN_LEFT_PAREN;
}
static GTokenType
plug_in_proc_arg_deserialize (GScanner *scanner,
Gimp *gimp,
GimpProcedure *procedure,
gboolean return_value)
{
GTokenType token;
GPParamDef param_def = { 0, };
GParamSpec *pspec;
if (! gimp_scanner_parse_token (scanner, G_TOKEN_LEFT_PAREN))
{
token = G_TOKEN_LEFT_PAREN;
goto error;
}
if (! gimp_scanner_parse_token (scanner, G_TOKEN_SYMBOL) ||
GPOINTER_TO_INT (scanner->value.v_symbol) != PROC_ARG)
{
token = G_TOKEN_SYMBOL;
goto error;
}
if (! gimp_scanner_parse_int (scanner, (gint *) &param_def.param_def_type))
{
token = G_TOKEN_INT;
goto error;
}
if (! gimp_scanner_parse_string (scanner, &param_def.type_name) ||
! gimp_scanner_parse_string (scanner, &param_def.value_type_name) ||
! gimp_scanner_parse_string (scanner, &param_def.name) ||
! gimp_scanner_parse_string (scanner, &param_def.nick) ||
! gimp_scanner_parse_string (scanner, &param_def.blurb) ||
! gimp_scanner_parse_int (scanner, (gint *) &param_def.flags))
{
token = G_TOKEN_STRING;
goto error;
}
switch (param_def.param_def_type)
{
case GP_PARAM_DEF_TYPE_DEFAULT:
break;
case GP_PARAM_DEF_TYPE_INT:
if (! gimp_scanner_parse_int64 (scanner,
&param_def.meta.m_int.min_val) ||
! gimp_scanner_parse_int64 (scanner,
&param_def.meta.m_int.max_val) ||
! gimp_scanner_parse_int64 (scanner,
&param_def.meta.m_int.default_val))
{
token = G_TOKEN_INT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_UNIT:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_unit.allow_pixels) ||
! gimp_scanner_parse_int (scanner,
&param_def.meta.m_unit.allow_percent) ||
! gimp_scanner_parse_int (scanner,
&param_def.meta.m_unit.default_val))
{
token = G_TOKEN_INT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_ENUM:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_enum.default_val))
{
token = G_TOKEN_STRING;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_CHOICE:
{
GimpChoice *choice;
gint n_choices;
if (! gimp_scanner_parse_string (scanner,
&param_def.meta.m_choice.default_val) ||
! gimp_scanner_parse_int (scanner, &n_choices))
{
token = G_TOKEN_INT;
goto error;
}
choice = gimp_choice_new ();
param_def.meta.m_choice.choice = choice;
for (int i = 0; i < n_choices; i++)
{
gchar *nick = NULL;
gchar *label = NULL;
gchar *help = NULL;
gint id;
if (! gimp_scanner_parse_string (scanner, &nick))
{
token = G_TOKEN_STRING;
goto error;
}
if (! gimp_scanner_parse_int (scanner, &id))
{
token = G_TOKEN_INT;
goto error;
}
if (! gimp_scanner_parse_string (scanner, &label) ||
! gimp_scanner_parse_string (scanner, &help))
{
token = G_TOKEN_STRING;
g_free (nick);
g_free (label);
g_free (help);
goto error;
}
gimp_choice_add (choice, nick, id, label, help);
g_free (nick);
g_free (label);
g_free (help);
}
}
break;
case GP_PARAM_DEF_TYPE_BOOLEAN:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_boolean.default_val))
{
token = G_TOKEN_INT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_FLOAT:
if (! gimp_scanner_parse_float (scanner,
&param_def.meta.m_float.min_val) ||
! gimp_scanner_parse_float (scanner,
&param_def.meta.m_float.max_val) ||
! gimp_scanner_parse_float (scanner,
&param_def.meta.m_float.default_val))
{
token = G_TOKEN_FLOAT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_STRING:
if (! gimp_scanner_parse_string (scanner,
&param_def.meta.m_string.default_val))
{
token = G_TOKEN_STRING;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_GEGL_COLOR:
{
GPParamColor *default_val = NULL;
gint bpp = 0;
guint8 *data = NULL;
gchar *encoding = NULL;
gint profile_size = 0;
guint8 *profile_data = NULL;
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_gegl_color.has_alpha))
{
token = G_TOKEN_INT;
goto error;
}
if (g_scanner_peek_next_token (scanner) == G_TOKEN_IDENTIFIER)
{
if (g_strcmp0 (scanner->next_value.v_identifier, "NULL") != 0)
{
token = G_TOKEN_INT;
goto error;
}
g_scanner_get_next_token (scanner);
/* NULL default color. Skip. */
}
else if (! gimp_scanner_parse_int (scanner, &bpp) ||
bpp > 40 ||
! gimp_scanner_parse_data (scanner, bpp, &data) ||
! gimp_scanner_parse_string (scanner, &encoding) ||
! gimp_scanner_parse_int (scanner, &profile_size))
{
g_free (data);
g_free (encoding);
token = G_TOKEN_INT;
goto error;
}
if (profile_size > 0 && ! gimp_scanner_parse_data (scanner, profile_size, &profile_data))
{
g_free (profile_data);
token = G_TOKEN_STRING;
goto error;
}
if (bpp > 0)
{
default_val = g_new0 (GPParamColor, 1);
memcpy (default_val->data, data, bpp);
default_val->size = bpp;
default_val->format.encoding = encoding;
default_val->format.profile_size = profile_size;
default_val->format.profile_data = profile_data;
}
else
{
g_free (encoding);
g_free (profile_data);
}
g_free (data);
param_def.meta.m_gegl_color.default_val = default_val;
}
break;
case GP_PARAM_DEF_TYPE_ID:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_id.none_ok))
{
token = G_TOKEN_INT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_ID_ARRAY:
if (! gimp_scanner_parse_string (scanner,
&param_def.meta.m_id_array.type_name))
{
token = G_TOKEN_STRING;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_EXPORT_OPTIONS:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_export_options.capabilities))
{
token = G_TOKEN_INT;
goto error;
}
break;
case GP_PARAM_DEF_TYPE_RESOURCE:
if (! gimp_scanner_parse_int (scanner,
&param_def.meta.m_resource.none_ok) ||
! gimp_scanner_parse_int (scanner,
&param_def.meta.m_resource.default_to_context) ||
! gimp_scanner_parse_int (scanner,
&param_def.meta.m_resource.default_resource_id))
{
token = G_TOKEN_INT;
goto error;
}
break;
break;
}
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
{
token = G_TOKEN_RIGHT_PAREN;
goto error;
}
token = G_TOKEN_LEFT_PAREN;
pspec = _gimp_gp_param_def_to_param_spec (&param_def);
if (return_value)
gimp_procedure_add_return_value (procedure, pspec);
else
gimp_procedure_add_argument (procedure, pspec);
error:
g_free (param_def.type_name);
g_free (param_def.value_type_name);
g_free (param_def.name);
g_free (param_def.nick);
g_free (param_def.blurb);
switch (param_def.param_def_type)
{
case GP_PARAM_DEF_TYPE_DEFAULT:
case GP_PARAM_DEF_TYPE_INT:
case GP_PARAM_DEF_TYPE_UNIT:
case GP_PARAM_DEF_TYPE_ENUM:
break;
case GP_PARAM_DEF_TYPE_BOOLEAN:
case GP_PARAM_DEF_TYPE_FLOAT:
break;
case GP_PARAM_DEF_TYPE_STRING:
g_free (param_def.meta.m_string.default_val);
break;
case GP_PARAM_DEF_TYPE_GEGL_COLOR:
if (param_def.meta.m_gegl_color.default_val)
{
g_free (param_def.meta.m_gegl_color.default_val->format.encoding);
g_free (param_def.meta.m_gegl_color.default_val->format.profile_data);
g_free (param_def.meta.m_gegl_color.default_val);
}
break;
case GP_PARAM_DEF_TYPE_ID:
break;
case GP_PARAM_DEF_TYPE_CHOICE:
g_clear_object (&param_def.meta.m_choice.choice);
g_free (param_def.meta.m_choice.default_val);
break;
case GP_PARAM_DEF_TYPE_ID_ARRAY:
g_free (param_def.meta.m_id_array.type_name);
break;
case GP_PARAM_DEF_TYPE_EXPORT_OPTIONS:
break;
case GP_PARAM_DEF_TYPE_RESOURCE:
break;
}
return token;
}
static GTokenType
plug_in_help_def_deserialize (GScanner *scanner,
GimpPlugInDef *plug_in_def)
{
gchar *domain_name;
gchar *domain_uri;
if (! gimp_scanner_parse_string (scanner, &domain_name))
return G_TOKEN_STRING;
if (! gimp_scanner_parse_string (scanner, &domain_uri))
domain_uri = NULL;
gimp_plug_in_def_set_help_domain (plug_in_def, domain_name, domain_uri);
g_free (domain_name);
g_free (domain_uri);
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
return G_TOKEN_LEFT_PAREN;
}
static GTokenType
plug_in_has_init_deserialize (GScanner *scanner,
GimpPlugInDef *plug_in_def)
{
gimp_plug_in_def_set_has_init (plug_in_def, TRUE);
if (! gimp_scanner_parse_token (scanner, G_TOKEN_RIGHT_PAREN))
return G_TOKEN_RIGHT_PAREN;
return G_TOKEN_LEFT_PAREN;
}
/* serialize functions */
static void
plug_in_rc_write_proc_arg (GimpConfigWriter *writer,
GParamSpec *pspec)
{
GPParamDef param_def = { 0, };
_gimp_param_spec_to_gp_param_def (pspec, &param_def);
gimp_config_writer_open (writer, "proc-arg");
gimp_config_writer_printf (writer, "%d", param_def.param_def_type);
gimp_config_writer_string (writer, param_def.type_name);
gimp_config_writer_string (writer, param_def.value_type_name);
gimp_config_writer_string (writer, g_param_spec_get_name (pspec));
gimp_config_writer_string (writer, g_param_spec_get_nick (pspec));
gimp_config_writer_string (writer, g_param_spec_get_blurb (pspec));
gimp_config_writer_printf (writer, "%d", pspec->flags);
switch (param_def.param_def_type)
{
gchar buf[4][G_ASCII_DTOSTR_BUF_SIZE];
case GP_PARAM_DEF_TYPE_DEFAULT:
break;
case GP_PARAM_DEF_TYPE_INT:
gimp_config_writer_printf (writer,
"%" G_GINT64_FORMAT
" %" G_GINT64_FORMAT
" %" G_GINT64_FORMAT,
param_def.meta.m_int.min_val,
param_def.meta.m_int.max_val,
param_def.meta.m_int.default_val);
break;
case GP_PARAM_DEF_TYPE_UNIT:
gimp_config_writer_printf (writer, "%d %d %d",
param_def.meta.m_unit.allow_pixels,
param_def.meta.m_unit.allow_percent,
param_def.meta.m_unit.default_val);
break;
case GP_PARAM_DEF_TYPE_ENUM:
gimp_config_writer_printf (writer, "%d",
param_def.meta.m_enum.default_val);
break;
case GP_PARAM_DEF_TYPE_CHOICE:
{
GList *choices;
choices = gimp_choice_list_nicks (param_def.meta.m_choice.choice);
gimp_config_writer_string (writer, param_def.meta.m_choice.default_val);
gimp_config_writer_printf (writer, "%d", g_list_length (choices));
for (GList *iter = choices; iter; iter = iter->next)
{
const gchar *nick = iter->data;
const gchar *label;
const gchar *help;
gint id;
gimp_choice_get_documentation (param_def.meta.m_choice.choice,
nick, &label, &help);
id = gimp_choice_get_id (param_def.meta.m_choice.choice, nick);
gimp_config_writer_string (writer, nick);
gimp_config_writer_printf (writer, "%d", id);
gimp_config_writer_string (writer, label);
gimp_config_writer_string (writer, help);
}
}
break;
case GP_PARAM_DEF_TYPE_BOOLEAN:
gimp_config_writer_printf (writer, "%d",
param_def.meta.m_boolean.default_val);
break;
case GP_PARAM_DEF_TYPE_FLOAT:
g_ascii_dtostr (buf[0], sizeof (buf[0]),
param_def.meta.m_float.min_val);
g_ascii_dtostr (buf[1], sizeof (buf[1]),
param_def.meta.m_float.max_val),
g_ascii_dtostr (buf[2], sizeof (buf[2]),
param_def.meta.m_float.default_val);
gimp_config_writer_printf (writer, "%s %s %s",
buf[0], buf[1], buf[2]);
break;
case GP_PARAM_DEF_TYPE_STRING:
gimp_config_writer_string (writer,
param_def.meta.m_string.default_val);
break;
case GP_PARAM_DEF_TYPE_GEGL_COLOR:
{
gint bpp = 0;
guint8 *data = NULL;
gchar *encoding = NULL;
guint32 profile_size = 0;
guint8 *profile_data = NULL;
gimp_config_writer_printf (writer, "%d",
param_def.meta.m_gegl_color.has_alpha);
if (param_def.meta.m_gegl_color.default_val &&
param_def.meta.m_gegl_color.default_val->size > 0)
{
bpp = param_def.meta.m_gegl_color.default_val->size;
data = param_def.meta.m_gegl_color.default_val->data;
encoding = param_def.meta.m_gegl_color.default_val->format.encoding;
profile_size = param_def.meta.m_gegl_color.default_val->format.profile_size;
profile_data = param_def.meta.m_gegl_color.default_val->format.profile_data;
gimp_config_writer_printf (writer, "%d", bpp);
gimp_config_writer_data (writer, bpp, data);
gimp_config_writer_string (writer, encoding);
gimp_config_writer_printf (writer, "%d", profile_size);
if (profile_size > 0)
gimp_config_writer_data (writer, profile_size, profile_data);
}
else
{
gimp_config_writer_printf (writer, "%s", "NULL");
}
}
break;
case GP_PARAM_DEF_TYPE_ID:
gimp_config_writer_printf (writer, "%d",
param_def.meta.m_id.none_ok);
break;
case GP_PARAM_DEF_TYPE_ID_ARRAY:
gimp_config_writer_string (writer,
param_def.meta.m_id_array.type_name);
break;
case GP_PARAM_DEF_TYPE_EXPORT_OPTIONS:
gimp_config_writer_printf (writer, "%d",
param_def.meta.m_export_options.capabilities);
break;
case GP_PARAM_DEF_TYPE_RESOURCE:
gimp_config_writer_printf (writer, "%d %d %d",
param_def.meta.m_resource.none_ok,
param_def.meta.m_resource.default_to_context,
param_def.meta.m_resource.default_resource_id);
break;
}
gimp_config_writer_close (writer);
}
gboolean
plug_in_rc_write (GSList *plug_in_defs,
GFile *file,
GError **error)
{
GimpConfigWriter *writer;
GEnumClass *enum_class;
GSList *list;
writer = gimp_config_writer_new_from_file (file,
FALSE,
"GIMP pluginrc\n\n"
"This file can safely be removed and "
"will be automatically regenerated by "
"querying the installed plug-ins.",
error);
if (! writer)
return FALSE;
enum_class = g_type_class_ref (GIMP_TYPE_ICON_TYPE);
gimp_config_writer_open (writer, "protocol-version");
gimp_config_writer_printf (writer, "%d", GIMP_PROTOCOL_VERSION);
gimp_config_writer_close (writer);
gimp_config_writer_open (writer, "file-version");
gimp_config_writer_printf (writer, "%d", PLUG_IN_RC_FILE_VERSION);
gimp_config_writer_close (writer);
gimp_config_writer_linefeed (writer);
for (list = plug_in_defs; list; list = list->next)
{
GimpPlugInDef *plug_in_def = list->data;
if (plug_in_def->procedures)
{
GSList *list2;
gchar *path;
path = gimp_file_get_config_path (plug_in_def->file, NULL);
if (! path)
continue;
gimp_config_writer_open (writer, "plug-in-def");
gimp_config_writer_string (writer, path);
gimp_config_writer_printf (writer, "%"G_GINT64_FORMAT,
plug_in_def->mtime);
g_free (path);
for (list2 = plug_in_def->procedures; list2; list2 = list2->next)
{
GimpPlugInProcedure *proc = list2->data;
GimpProcedure *procedure = GIMP_PROCEDURE (proc);
GEnumValue *enum_value;
GList *list3;
gint i;
if (proc->installed_during_init)
continue;
gimp_config_writer_open (writer, "proc-def");
gimp_config_writer_printf (writer, "\"%s\" %d",
gimp_object_get_name (procedure),
procedure->proc_type);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, procedure->blurb);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, procedure->help);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, procedure->authors);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, procedure->copyright);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, procedure->date);
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, proc->menu_label);
gimp_config_writer_linefeed (writer);
gimp_config_writer_printf (writer, "%d",
g_list_length (proc->menu_paths));
for (list3 = proc->menu_paths; list3; list3 = list3->next)
{
gimp_config_writer_open (writer, "menu-path");
gimp_config_writer_string (writer, list3->data);
gimp_config_writer_close (writer);
}
gimp_config_writer_open (writer, "icon");
enum_value = g_enum_get_value (enum_class, proc->icon_type);
gimp_config_writer_identifier (writer, enum_value->value_nick);
gimp_config_writer_printf (writer, "%d",
proc->icon_data_length);
switch (proc->icon_type)
{
case GIMP_ICON_TYPE_ICON_NAME:
case GIMP_ICON_TYPE_IMAGE_FILE:
gimp_config_writer_string (writer, (gchar *) proc->icon_data);
break;
case GIMP_ICON_TYPE_PIXBUF:
gimp_config_writer_data (writer, proc->icon_data_length,
proc->icon_data);
break;
}
gimp_config_writer_close (writer);
if (proc->file_proc)
{
gimp_config_writer_open (writer,
proc->image_types ?
"save-proc" : "load-proc");
if (proc->extensions && *proc->extensions)
{
gimp_config_writer_open (writer, "extensions");
gimp_config_writer_string (writer, proc->extensions);
gimp_config_writer_close (writer);
}
if (proc->prefixes && *proc->prefixes)
{
gimp_config_writer_open (writer, "prefixes");
gimp_config_writer_string (writer, proc->prefixes);
gimp_config_writer_close (writer);
}
if (proc->magics && *proc->magics)
{
gimp_config_writer_open (writer, "magics");
gimp_config_writer_string (writer, proc->magics);
gimp_config_writer_close (writer);
}
if (proc->priority)
{
gimp_config_writer_open (writer, "priority");
gimp_config_writer_printf (writer, "%d", proc->priority);
gimp_config_writer_close (writer);
}
if (proc->mime_types && *proc->mime_types)
{
gimp_config_writer_open (writer, "mime-types");
gimp_config_writer_string (writer, proc->mime_types);
gimp_config_writer_close (writer);
}
if (proc->priority)
{
gimp_config_writer_open (writer, "priority");
gimp_config_writer_printf (writer, "%d", proc->priority);
gimp_config_writer_close (writer);
}
if (proc->handles_remote)
{
gimp_config_writer_open (writer, "handles-remote");
gimp_config_writer_close (writer);
}
if (proc->handles_raw && ! proc->image_types)
{
gimp_config_writer_open (writer, "handles-raw");
gimp_config_writer_close (writer);
}
if (proc->handles_vector)
{
gimp_config_writer_open (writer, "handles-vector");
gimp_config_writer_close (writer);
}
if (proc->thumb_loader)
{
gimp_config_writer_open (writer, "thumb-loader");
gimp_config_writer_string (writer, proc->thumb_loader);
gimp_config_writer_close (writer);
}
gimp_config_writer_close (writer);
}
else if (proc->batch_interpreter)
{
gimp_config_writer_open (writer, "batch-interpreter");
gimp_config_writer_string (writer, proc->batch_interpreter_name);
gimp_config_writer_close (writer);
}
gimp_config_writer_linefeed (writer);
gimp_config_writer_string (writer, proc->image_types);
gimp_config_writer_linefeed (writer);
gimp_config_writer_printf (writer, "%d",
proc->sensitivity_mask);
gimp_config_writer_linefeed (writer);
gimp_config_writer_printf (writer, "%d %d",
procedure->num_args,
procedure->num_values);
for (i = 0; i < procedure->num_args; i++)
{
GParamSpec *pspec = procedure->args[i];
plug_in_rc_write_proc_arg (writer, pspec);
}
for (i = 0; i < procedure->num_values; i++)
{
GParamSpec *pspec = procedure->values[i];
plug_in_rc_write_proc_arg (writer, pspec);
}
gimp_config_writer_close (writer);
}
if (plug_in_def->help_domain_name)
{
gimp_config_writer_open (writer, "help-def");
gimp_config_writer_string (writer,
plug_in_def->help_domain_name);
if (plug_in_def->help_domain_uri)
gimp_config_writer_string (writer,
plug_in_def->help_domain_uri);
gimp_config_writer_close (writer);
}
if (plug_in_def->has_init)
{
gimp_config_writer_open (writer, "has-init");
gimp_config_writer_close (writer);
}
gimp_config_writer_close (writer);
}
}
g_type_class_unref (enum_class);
return gimp_config_writer_finish (writer, "end of pluginrc", error);
}