304 lines
10 KiB
C
304 lines
10 KiB
C
/* PIKA - Photo and Image Kooker Application
|
|
* a rebranding of The GNU Image Manipulation Program (created with heckimp)
|
|
* A derived work which may be trivial. However, any changes may be (C)2023 by Aldercone Studio
|
|
*
|
|
* Original copyright, applying to most contents (license remains unchanged):
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* pikabatchprocedure.c
|
|
* Copyright (C) 2022 Jehan
|
|
*
|
|
* 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 "pika.h"
|
|
#include "pikabatchprocedure.h"
|
|
#include "pikapdb_pdb.h"
|
|
|
|
|
|
struct _PikaBatchProcedurePrivate
|
|
{
|
|
gchar *interpreter_name;
|
|
|
|
PikaBatchFunc run_func;
|
|
gpointer run_data;
|
|
GDestroyNotify run_data_destroy;
|
|
|
|
};
|
|
|
|
|
|
static void pika_batch_procedure_constructed (GObject *object);
|
|
static void pika_batch_procedure_finalize (GObject *object);
|
|
|
|
static void pika_batch_procedure_install (PikaProcedure *procedure);
|
|
static PikaValueArray *
|
|
pika_batch_procedure_run (PikaProcedure *procedure,
|
|
const PikaValueArray *args);
|
|
static PikaProcedureConfig *
|
|
pika_batch_procedure_create_config (PikaProcedure *procedure,
|
|
GParamSpec **args,
|
|
gint n_args);
|
|
|
|
G_DEFINE_TYPE_WITH_PRIVATE (PikaBatchProcedure, pika_batch_procedure,
|
|
PIKA_TYPE_PROCEDURE)
|
|
|
|
#define parent_class pika_batch_procedure_parent_class
|
|
|
|
|
|
static void
|
|
pika_batch_procedure_class_init (PikaBatchProcedureClass *klass)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
|
PikaProcedureClass *procedure_class = PIKA_PROCEDURE_CLASS (klass);
|
|
|
|
object_class->constructed = pika_batch_procedure_constructed;
|
|
object_class->finalize = pika_batch_procedure_finalize;
|
|
|
|
procedure_class->install = pika_batch_procedure_install;
|
|
procedure_class->run = pika_batch_procedure_run;
|
|
procedure_class->create_config = pika_batch_procedure_create_config;
|
|
}
|
|
|
|
static void
|
|
pika_batch_procedure_init (PikaBatchProcedure *procedure)
|
|
{
|
|
procedure->priv = pika_batch_procedure_get_instance_private (procedure);
|
|
}
|
|
|
|
static void
|
|
pika_batch_procedure_constructed (GObject *object)
|
|
{
|
|
PikaProcedure *procedure = PIKA_PROCEDURE (object);
|
|
|
|
G_OBJECT_CLASS (parent_class)->constructed (object);
|
|
|
|
PIKA_PROC_ARG_ENUM (procedure, "run-mode",
|
|
"Run mode",
|
|
"The run mode",
|
|
PIKA_TYPE_RUN_MODE,
|
|
PIKA_RUN_NONINTERACTIVE,
|
|
G_PARAM_READWRITE);
|
|
|
|
PIKA_PROC_ARG_STRING (procedure, "script",
|
|
"Batch commands in the target language",
|
|
"Batch commands in the target language, which will be run by the interpreter",
|
|
"",
|
|
G_PARAM_READWRITE);
|
|
}
|
|
|
|
static void
|
|
pika_batch_procedure_finalize (GObject *object)
|
|
{
|
|
PikaBatchProcedure *procedure = PIKA_BATCH_PROCEDURE (object);
|
|
|
|
g_clear_pointer (&procedure->priv->interpreter_name, g_free);
|
|
|
|
G_OBJECT_CLASS (parent_class)->finalize (object);
|
|
}
|
|
|
|
static void
|
|
pika_batch_procedure_install (PikaProcedure *procedure)
|
|
{
|
|
PikaBatchProcedure *proc = PIKA_BATCH_PROCEDURE (procedure);
|
|
|
|
g_return_if_fail (proc->priv->interpreter_name != NULL);
|
|
|
|
PIKA_PROCEDURE_CLASS (parent_class)->install (procedure);
|
|
|
|
_pika_pdb_set_batch_interpreter (pika_procedure_get_name (procedure),
|
|
proc->priv->interpreter_name);
|
|
}
|
|
|
|
#define ARG_OFFSET 2
|
|
|
|
static PikaValueArray *
|
|
pika_batch_procedure_run (PikaProcedure *procedure,
|
|
const PikaValueArray *args)
|
|
{
|
|
PikaBatchProcedure *batch_proc = PIKA_BATCH_PROCEDURE (procedure);
|
|
PikaValueArray *remaining;
|
|
PikaValueArray *return_values;
|
|
PikaRunMode run_mode;
|
|
const gchar *cmd;
|
|
gint i;
|
|
|
|
run_mode = PIKA_VALUES_GET_ENUM (args, 0);
|
|
cmd = PIKA_VALUES_GET_STRING (args, 1);
|
|
|
|
remaining = pika_value_array_new (pika_value_array_length (args) - ARG_OFFSET);
|
|
|
|
for (i = ARG_OFFSET; i < pika_value_array_length (args); i++)
|
|
{
|
|
GValue *value = pika_value_array_index (args, i);
|
|
|
|
pika_value_array_append (remaining, value);
|
|
}
|
|
|
|
return_values = batch_proc->priv->run_func (procedure,
|
|
run_mode,
|
|
cmd,
|
|
remaining,
|
|
batch_proc->priv->run_data);
|
|
pika_value_array_unref (remaining);
|
|
|
|
return return_values;
|
|
}
|
|
|
|
static PikaProcedureConfig *
|
|
pika_batch_procedure_create_config (PikaProcedure *procedure,
|
|
GParamSpec **args,
|
|
gint n_args)
|
|
{
|
|
if (n_args > ARG_OFFSET)
|
|
{
|
|
args += ARG_OFFSET;
|
|
n_args -= ARG_OFFSET;
|
|
}
|
|
else
|
|
{
|
|
args = NULL;
|
|
n_args = 0;
|
|
}
|
|
|
|
return PIKA_PROCEDURE_CLASS (parent_class)->create_config (procedure,
|
|
args,
|
|
n_args);
|
|
}
|
|
|
|
/* public functions */
|
|
|
|
/**
|
|
* pika_batch_procedure_new:
|
|
* @plug_in: a #PikaPlugIn.
|
|
* @name: the new procedure's name.
|
|
* @interpreter_name: the public-facing name, e.g. "Python 3".
|
|
* @proc_type: the new procedure's #PikaPDBProcType.
|
|
* @run_func: the run function for the new procedure.
|
|
* @run_data: user data passed to @run_func.
|
|
* @run_data_destroy: (nullable): free function for @run_data, or %NULL.
|
|
*
|
|
* Creates a new batch interpreter procedure named @name which will call
|
|
* @run_func when invoked.
|
|
*
|
|
* See pika_procedure_new() for information about @proc_type.
|
|
*
|
|
* #PikaBatchProcedure is a #PikaProcedure subclass that makes it easier
|
|
* to write batch interpreter procedures.
|
|
*
|
|
* It automatically adds the standard
|
|
*
|
|
* (#PikaRunMode, #gchar)
|
|
*
|
|
* arguments of a batch procedure. It is possible to add additional
|
|
* arguments.
|
|
*
|
|
* When invoked via pika_procedure_run(), it unpacks these standard
|
|
* arguments and calls @run_func which is a #PikaBatchFunc. The "args"
|
|
* #PikaValueArray of #PikaRunSaveFunc only contains additionally added
|
|
* arguments.
|
|
*
|
|
* Returns: a new #PikaProcedure.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
PikaProcedure *
|
|
pika_batch_procedure_new (PikaPlugIn *plug_in,
|
|
const gchar *name,
|
|
const gchar *interpreter_name,
|
|
PikaPDBProcType proc_type,
|
|
PikaBatchFunc run_func,
|
|
gpointer run_data,
|
|
GDestroyNotify run_data_destroy)
|
|
{
|
|
PikaBatchProcedure *procedure;
|
|
|
|
g_return_val_if_fail (PIKA_IS_PLUG_IN (plug_in), NULL);
|
|
g_return_val_if_fail (pika_is_canonical_identifier (name), NULL);
|
|
g_return_val_if_fail (interpreter_name != NULL && g_utf8_validate (interpreter_name, -1, NULL), NULL);
|
|
g_return_val_if_fail (proc_type != PIKA_PDB_PROC_TYPE_INTERNAL, NULL);
|
|
g_return_val_if_fail (proc_type != PIKA_PDB_PROC_TYPE_EXTENSION, NULL);
|
|
g_return_val_if_fail (run_func != NULL, NULL);
|
|
|
|
procedure = g_object_new (PIKA_TYPE_BATCH_PROCEDURE,
|
|
"plug-in", plug_in,
|
|
"name", name,
|
|
"procedure-type", proc_type,
|
|
NULL);
|
|
|
|
procedure->priv->run_func = run_func;
|
|
procedure->priv->run_data = run_data;
|
|
procedure->priv->run_data_destroy = run_data_destroy;
|
|
|
|
pika_batch_procedure_set_interpreter_name (procedure, interpreter_name);
|
|
|
|
return PIKA_PROCEDURE (procedure);
|
|
}
|
|
|
|
/**
|
|
* pika_batch_procedure_set_interpreter_name:
|
|
* @procedure: A batch procedure.
|
|
* @interpreter_name: A public-facing name for the interpreter, e.g. "Python 3".
|
|
*
|
|
* Associates an interpreter name with a batch procedure.
|
|
*
|
|
* This name can be used for any public-facing strings, such as
|
|
* graphical interface labels or command line usage. E.g. the command
|
|
* line interface could list all available interface, displaying both a
|
|
* procedure name and a "pretty printing" title.
|
|
*
|
|
* Note that since the format name is public-facing, it is recommended
|
|
* to localize it at runtime, for instance through gettext, like:
|
|
*
|
|
* ```c
|
|
* pika_batch_procedure_set_interpreter_name (procedure, _("Python 3"));
|
|
* ```
|
|
*
|
|
* Some language would indeed localize even some technical terms or
|
|
* acronyms, even if sometimes just to rewrite them with the local
|
|
* writing system.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
void
|
|
pika_batch_procedure_set_interpreter_name (PikaBatchProcedure *procedure,
|
|
const gchar *interpreter_name)
|
|
{
|
|
g_return_if_fail (PIKA_IS_BATCH_PROCEDURE (procedure));
|
|
g_return_if_fail (interpreter_name != NULL && g_utf8_validate (interpreter_name, -1, NULL));
|
|
|
|
g_free (procedure->priv->interpreter_name);
|
|
procedure->priv->interpreter_name = g_strdup (interpreter_name);
|
|
}
|
|
|
|
/**
|
|
* pika_batch_procedure_get_interpreter_name:
|
|
* @procedure: A batch procedure object.
|
|
*
|
|
* Returns the procedure's interpreter name, as set with
|
|
* [method@BatchProcedure.set_interpreter_name].
|
|
*
|
|
* Returns: The procedure's interpreter name.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
const gchar *
|
|
pika_batch_procedure_get_interpreter_name (PikaBatchProcedure *procedure)
|
|
{
|
|
g_return_val_if_fail (PIKA_IS_BATCH_PROCEDURE (procedure), NULL);
|
|
|
|
return procedure->priv->interpreter_name;
|
|
}
|
