1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
|
/* GIMP - The GNU Image Manipulation Program
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimppdb.c
* Copyright (C) 2019 Michael Natterer <mitch@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 "gimp.h"
#include "libgimpbase/gimpprotocol.h"
#include "libgimpbase/gimpwire.h"
#include "gimpgpparams.h"
#include "gimppdb-private.h"
#include "gimppdb_pdb.h"
#include "gimppdbprocedure.h"
#include "gimpplugin-private.h"
#include "libgimp-intl.h"
/**
* GimpPDB:
*
* Provides access to the Procedural DataBase (PDB).
*/
struct _GimpPDB
{
GObject parent_instance;
GimpPlugIn *plug_in;
GHashTable *procedures;
GimpPDBStatusType error_status;
gchar *error_message;
};
static void gimp_pdb_dispose (GObject *object);
static void gimp_pdb_finalize (GObject *object);
static void gimp_pdb_set_error (GimpPDB *pdb,
GimpValueArray *return_values);
G_DEFINE_TYPE (GimpPDB, gimp_pdb, G_TYPE_OBJECT)
#define parent_class gimp_pdb_parent_class
static void
gimp_pdb_class_init (GimpPDBClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = gimp_pdb_dispose;
object_class->finalize = gimp_pdb_finalize;
}
static void
gimp_pdb_init (GimpPDB *pdb)
{
pdb->procedures = g_hash_table_new_full (g_str_hash, g_str_equal,
g_free, g_object_unref);
pdb->error_status = GIMP_PDB_SUCCESS;
}
static void
gimp_pdb_dispose (GObject *object)
{
GimpPDB *pdb = GIMP_PDB (object);
g_clear_pointer (&pdb->procedures, g_hash_table_unref);
G_OBJECT_CLASS (parent_class)->dispose (object);
}
static void
gimp_pdb_finalize (GObject *object)
{
GimpPDB *pdb = GIMP_PDB (object);
g_clear_object (&pdb->plug_in);
g_clear_pointer (&pdb->error_message, g_free);
G_OBJECT_CLASS (parent_class)->finalize (object);
}
GimpPDB *
_gimp_pdb_new (GimpPlugIn *plug_in)
{
GimpPDB *pdb;
g_return_val_if_fail (GIMP_IS_PLUG_IN (plug_in), NULL);
pdb = g_object_new (GIMP_TYPE_PDB, NULL);
pdb->plug_in = g_object_ref (plug_in);
return pdb;
}
GimpPlugIn *
_gimp_pdb_get_plug_in (GimpPDB *pdb)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
return pdb->plug_in;
}
/**
* gimp_pdb_procedure_exists:
* @pdb: A PDB instance.
* @procedure_name: A procedure name
*
* This function checks if a procedure exists in the procedural
* database.
*
* Return: %TRUE if the procedure exists, %FALSE otherwise.
*
* Since: 3.0
**/
gboolean
gimp_pdb_procedure_exists (GimpPDB *pdb,
const gchar *procedure_name)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), FALSE);
g_return_val_if_fail (gimp_is_canonical_identifier (procedure_name), FALSE);
return _gimp_pdb_proc_exists (procedure_name);
}
/**
* gimp_pdb_lookup_procedure:
* @pdb: A #GimpPDB instance.
* @procedure_name: A procedure name
*
* This function returns the [class@Procedure] which is registered
* with @procedure_name if it exists, or returns %NULL otherwise.
*
* The returned [class@Procedure] is owned by @pdb and must not be modified.
*
* Return: (nullable) (transfer none): A [class@Procedure], or %NULL.
*
* Since: 3.0
**/
GimpProcedure *
gimp_pdb_lookup_procedure (GimpPDB *pdb,
const gchar *procedure_name)
{
GimpProcedure *procedure;
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
g_return_val_if_fail (gimp_is_canonical_identifier (procedure_name), NULL);
procedure = g_hash_table_lookup (pdb->procedures, procedure_name);
if (! procedure && gimp_is_canonical_identifier (procedure_name) &&
_gimp_pdb_proc_exists (procedure_name))
{
procedure = _gimp_pdb_procedure_new (pdb, procedure_name);
if (procedure)
g_hash_table_insert (pdb->procedures,
g_strdup (procedure_name), procedure);
}
return procedure;
}
/**
* gimp_pdb_temp_procedure_name:
* @pdb: the #GimpPDB object.
*
* Generates a unique temporary PDB name.
*
* This function generates a temporary PDB entry name that is
* guaranteed to be unique.
*
* Returns: (transfer full): A unique temporary name for a temporary
* PDB entry. The returned value must be freed with
* g_free().
*
* Since: 3.0
**/
gchar *
gimp_pdb_temp_procedure_name (GimpPDB *pdb)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
return _gimp_pdb_temp_name ();
}
/**
* gimp_pdb_dump_to_file:
* @pdb: A #GimpPDB.
* @file: The dump file.
*
* Dumps the current contents of the procedural database
*
* This procedure dumps the contents of the procedural database to the
* specified @file. The file will contain all of the information
* provided for each registered procedure.
*
* Returns: TRUE on success.
*
* Since: 3.0
**/
gboolean
gimp_pdb_dump_to_file (GimpPDB *pdb,
GFile *file)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), FALSE);
g_return_val_if_fail (G_IS_FILE (file), FALSE);
return _gimp_pdb_dump (file);
}
/**
* gimp_pdb_query_procedures:
* @pdb: A #GimpPDB.
* @name: The regex for procedure name.
* @blurb: The regex for procedure blurb.
* @help: The regex for procedure help.
* @help_id: The regex for procedure help-id.
* @authors: The regex for procedure authors.
* @copyright: The regex for procedure copyright.
* @date: The regex for procedure date.
* @proc_type: The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension', 'Temporary Procedure' }.
*
* Queries the procedural database for its contents using regular
* expression matching.
*
* This function queries the contents of the procedural database. It
* is supplied with eight arguments matching procedures on
*
* { name, blurb, help, help-id, authors, copyright, date, procedure type}.
*
* This is accomplished using regular expression matching. For
* instance, to find all procedures with "jpeg" listed in the blurb,
* all seven arguments can be supplied as ".*", except for the second,
* which can be supplied as ".*jpeg.*". There are two return arguments
* for this procedure. The first is the number of procedures matching
* the query. The second is a concatenated list of procedure names
* corresponding to those matching the query. If no matching entries
* are found, then the returned string is NULL and the number of
* entries is 0.
*
* Returns: (array zero-terminated=1) (transfer full): The list
* of procedure names. Free with g_strfreev().
*
* Since: 3.0
**/
gchar **
gimp_pdb_query_procedures (GimpPDB *pdb,
const gchar *name,
const gchar *blurb,
const gchar *help,
const gchar *help_id,
const gchar *authors,
const gchar *copyright,
const gchar *date,
const gchar *proc_type)
{
gchar **matches;
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
_gimp_pdb_query (name,
blurb, help, /* FIXME help_id */
authors, copyright, date,
proc_type,
&matches);
return matches;
}
GQuark
_gimp_pdb_error_quark (void)
{
return g_quark_from_static_string ("gimp-pdb-error-quark");
}
/**
* gimp_pdb_get_last_error:
* @pdb: a #GimpPDB.
*
* Retrieves the error message from the last procedure call.
*
* If a procedure call fails, then it might pass an error message with
* the return values. Plug-ins that are using the libgimp C wrappers
* don't access the procedure return values directly. Thus #GimpPDB
* stores the error message and makes it available with this
* function. The next procedure call unsets the error message again.
*
* The returned string is owned by @pdb and must not be freed or
* modified.
*
* Returns: the error message
*
* Since: 3.0
**/
const gchar *
gimp_pdb_get_last_error (GimpPDB *pdb)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
if (pdb->error_message && strlen (pdb->error_message))
return pdb->error_message;
switch (pdb->error_status)
{
case GIMP_PDB_SUCCESS:
/* procedure executed successfully */
return _("success");
case GIMP_PDB_EXECUTION_ERROR:
/* procedure execution failed */
return _("execution error");
case GIMP_PDB_CALLING_ERROR:
/* procedure called incorrectly */
return _("calling error");
case GIMP_PDB_CANCEL:
/* procedure execution cancelled */
return _("cancelled");
default:
return "invalid return status";
}
}
/**
* gimp_pdb_get_last_status:
* @pdb: a #GimpPDB.
*
* Retrieves the status from the last procedure call.
*
* Returns: the #GimpPDBStatusType.
*
* Since: 3.0
**/
GimpPDBStatusType
gimp_pdb_get_last_status (GimpPDB *pdb)
{
g_return_val_if_fail (GIMP_IS_PDB (pdb), GIMP_PDB_SUCCESS);
return pdb->error_status;
}
/* Cruft API */
/**
* gimp_pdb_get_data:
* @identifier: The identifier associated with data.
* @data: A byte array containing data.
*
* Returns data associated with the specified identifier.
*
* This procedure returns any data which may have been associated with
* the specified identifier. The data is copied into the given memory
* location.
*
* WARNING: this function is exported in the library so that it can be used by
* libgimpwidgets. Nevertheless it is considered internal, and is not declared
* in any public header on purpose. It should not be considered part of the API
* and therefore should not be used in plug-ins. It may disappear at any time.
*
* Returns: TRUE on success, FALSE if no data has been associated with
* the identifier
*/
gboolean
gimp_pdb_get_data (const gchar *identifier,
GBytes **data)
{
return _gimp_pdb_get_data (identifier, data);
}
/**
* gimp_pdb_set_data:
* @identifier: The identifier associated with data.
* @data: (array length=data_len): A byte array containing data.
* @data_len: The number of bytes in the data
*
* Associates the specified identifier with the supplied data.
*
* This procedure associates the supplied data with the provided
* identifier. The data may be subsequently retrieved by a call to
* 'procedural-db-get-data'. This storage is global within the session, even
* shareable between plug-ins, though it won't survive a restart of GIMP.
*
* WARNING: this function is exported in the library so that it can be used by
* libgimpwidgets. Nevertheless it is considered internal, and is not declared
* in any public header on purpose. It should not be considered part of the API
* and therefore should not be used in plug-ins. It may disappear at any time.
* Returns: TRUE on success.
*/
gboolean
gimp_pdb_set_data (const gchar *identifier,
GBytes *data)
{
return _gimp_pdb_set_data (identifier, data);
}
/**
* _gimp_pdb_run_procedure_array:
* @pdb: the #GimpPDB object.
* @procedure_name: the procedure registered name.
* @arguments: the call arguments.
*
* Runs the procedure named @procedure_name with @arguments.
*
* Returns: (transfer full): the return values for the procedure call.
*
* Since: 3.0
*/
GimpValueArray *
_gimp_pdb_run_procedure_array (GimpPDB *pdb,
const gchar *procedure_name,
const GimpValueArray *arguments)
{
GPProcRun proc_run;
GPProcReturn *proc_return;
GimpWireMessage msg;
GimpValueArray *return_values;
g_return_val_if_fail (GIMP_IS_PDB (pdb), NULL);
g_return_val_if_fail (gimp_is_canonical_identifier (procedure_name), NULL);
g_return_val_if_fail (arguments != NULL, NULL);
proc_run.name = (gchar *) procedure_name;
proc_run.n_params = gimp_value_array_length (arguments);
proc_run.params = _gimp_value_array_to_gp_params (arguments, FALSE);
if (! gp_proc_run_write (_gimp_plug_in_get_write_channel (pdb->plug_in),
&proc_run, pdb->plug_in))
gimp_quit ();
_gimp_gp_params_free (proc_run.params, proc_run.n_params, FALSE);
_gimp_plug_in_read_expect_msg (pdb->plug_in, &msg, GP_PROC_RETURN);
proc_return = msg.data;
return_values = _gimp_gp_params_to_value_array (NULL,
NULL, 0,
proc_return->params,
proc_return->n_params,
TRUE);
gimp_wire_destroy (&msg);
gimp_pdb_set_error (pdb, return_values);
return return_values;
}
/* private functions */
static void
gimp_pdb_set_error (GimpPDB *pdb,
GimpValueArray *return_values)
{
g_clear_pointer (&pdb->error_message, g_free);
pdb->error_status = GIMP_PDB_SUCCESS;
if (gimp_value_array_length (return_values) > 0)
{
pdb->error_status = GIMP_VALUES_GET_ENUM (return_values, 0);
switch (pdb->error_status)
{
case GIMP_PDB_SUCCESS:
case GIMP_PDB_PASS_THROUGH:
break;
case GIMP_PDB_EXECUTION_ERROR:
case GIMP_PDB_CALLING_ERROR:
case GIMP_PDB_CANCEL:
if (gimp_value_array_length (return_values) > 1)
{
GValue *value = gimp_value_array_index (return_values, 1);
if (G_VALUE_HOLDS_STRING (value))
pdb->error_message = g_value_dup_string (value);
}
break;
}
}
}
|