f25e0448b2
This goes with our planned change of not making GimpProcedure arguments order relevant anymore regarding the PDB API. In particular, it means we don't want to use GimpValueArray for various procedure arguments API, but directly GimpProcedureConfig objects. This change will allow to add or reorder arguments in the future, so that we won't have to create new PDB procedures when adding new arguments, while still keeping PDB API stability.
149 lines
5.1 KiB
C
149 lines
5.1 KiB
C
/* 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 <libgimp/gimp.h>
|
|
|
|
#include "script-fu-types.h" /* SFScript */
|
|
#include "script-fu-lib.h"
|
|
#include "script-fu-script.h"
|
|
|
|
#include "script-fu-command.h"
|
|
|
|
|
|
/* Methods for interpreting commands.
|
|
*
|
|
* Usually there is a stack of calls similar to:
|
|
* script_fu_run_image_procedure (outer run func)
|
|
* calls script_fu_interpret_image_proc
|
|
* calls script_fu_run_command
|
|
* calls ts_interpret_string
|
|
* calls the inner run func in Scheme
|
|
*
|
|
* but script_fu_run_command is also called directly for loading scripts.
|
|
*
|
|
* FUTURE: see also similar code in script-fu-interface.c
|
|
* which could be migrated here.
|
|
*/
|
|
|
|
|
|
/* Interpret a command.
|
|
*
|
|
* When errors during interpretation:
|
|
* 1) set the error message from tinyscheme into GError at given handle.
|
|
* 2) return FALSE
|
|
* otherwise, return TRUE and discard any result of interpretation
|
|
* ScriptFu return values only have a GimpPDBStatus,
|
|
* since ScriptFu plugin scripts can only be declared returning void.
|
|
*
|
|
* While interpreting, any errors from further calls to the PDB
|
|
* can show error dialogs in any GIMP gui,
|
|
* unless the caller has taken responsibility with a prior call to
|
|
* gimp_plug_in_set_pdb_error_handler
|
|
*
|
|
* FIXME: see script_fu_run_procedure.
|
|
* It does not call gimp_plug_in_set_pdb_error_handler for NON-INTERACTIVE mode.
|
|
*/
|
|
gboolean
|
|
script_fu_run_command (const gchar *command,
|
|
GError **error)
|
|
{
|
|
GString *output;
|
|
gboolean success = FALSE;
|
|
|
|
g_debug ("script_fu_run_command: %s", command);
|
|
output = g_string_new (NULL);
|
|
script_fu_redirect_output_to_gstr (output);
|
|
|
|
if (script_fu_interpret_string (command))
|
|
{
|
|
g_set_error (error, GIMP_PLUG_IN_ERROR, 0, "%s", output->str);
|
|
}
|
|
else
|
|
{
|
|
success = TRUE;
|
|
}
|
|
|
|
g_string_free (output, TRUE);
|
|
|
|
return success;
|
|
}
|
|
|
|
|
|
|
|
/* Interpret a script that defines a GimpImageProcedure.
|
|
*
|
|
* Similar to v2 code in script-fu-interface.c, except:
|
|
* 1) builds a command from a GValueArray from a GimpConfig,
|
|
* instead of from local array of SFArg.
|
|
* 2) adds actual args image, drawable, etc. for GimpImageProcedure
|
|
*/
|
|
GimpValueArray *
|
|
script_fu_interpret_image_proc (GimpProcedure *procedure,
|
|
SFScript *script,
|
|
GimpImage *image,
|
|
guint n_drawables,
|
|
GimpDrawable **drawables,
|
|
GimpProcedureConfig *config)
|
|
{
|
|
gchar *command;
|
|
GimpValueArray *result = NULL;
|
|
gboolean interpretation_result;
|
|
GError *error = NULL;
|
|
|
|
command = script_fu_script_get_command_for_image_proc (script, image, n_drawables, drawables, config);
|
|
|
|
/* Take responsibility for handling errors from the scripts further calls to PDB.
|
|
* ScriptFu does not show an error dialog, but forwards errors back to GIMP.
|
|
* This only tells GIMP that ScriptFu itself will forward GimpPDBStatus errors from
|
|
* this scripts calls to the PDB.
|
|
* The onus is on this script's called PDB procedures to return errors in the GimpPDBStatus.
|
|
* Any that do not, but for example only call gimp-message, are breaching contract.
|
|
*/
|
|
gimp_plug_in_set_pdb_error_handler (gimp_get_plug_in (),
|
|
GIMP_PDB_ERROR_HANDLER_PLUGIN);
|
|
|
|
interpretation_result = script_fu_run_command (command, &error);
|
|
g_free (command);
|
|
if (! interpretation_result)
|
|
{
|
|
/* This is to the console.
|
|
* script->name not localized.
|
|
* error->message expected to be localized.
|
|
* GIMP will later display "PDB procedure failed: <message>" localized.
|
|
*/
|
|
g_warning ("While executing %s: %s",
|
|
script->name,
|
|
error->message);
|
|
/* A GError was allocated and this will take ownership. */
|
|
result = gimp_procedure_new_return_values (procedure,
|
|
GIMP_PDB_EXECUTION_ERROR,
|
|
error);
|
|
}
|
|
else
|
|
{
|
|
result = gimp_procedure_new_return_values (procedure,
|
|
GIMP_PDB_SUCCESS,
|
|
NULL);
|
|
}
|
|
|
|
gimp_plug_in_set_pdb_error_handler (gimp_get_plug_in (),
|
|
GIMP_PDB_ERROR_HANDLER_INTERNAL);
|
|
|
|
return result;
|
|
}
|