gimpfileops_pdb.c 16.3 KB
Newer Older
1
/* LIBGIMP - The GIMP Library
2
 * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
3 4 5
 *
 * gimpfileops_pdb.c
 *
6
 * This library is free software: you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
10 11 12 13
 *
 * This library 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
14
 * Lesser General Public License for more details.
15 16
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
18
 * <https://www.gnu.org/licenses/>.
19 20
 */

21
/* NOTE: This file is auto-generated by pdbgen.pl */
22

Sven Neumann's avatar
Sven Neumann committed
23 24
#include "config.h"

25 26
#include <string.h>

27
#include "gimp.h"
28

29 30 31 32

/**
 * SECTION: gimpfileops
 * @title: gimpfileops
33
 * @short_description: Image file operations (load, save, etc.)
34
 *
35
 * Image file operations (load, save, etc.)
36 37 38
 **/


39 40 41 42
/**
 * gimp_file_load:
 * @run_mode: The run mode.
 * @filename: The name of the file to load.
43
 * @raw_filename: The name as entered by the user.
44
 *
45
 * Loads an image file by invoking the right load handler.
46
 *
47 48 49 50 51
 * This procedure invokes the correct file load handler using magic if
 * possible, and falling back on the file's extension and/or prefix if
 * not. The name of the file to load is typically a full pathname, and
 * the name entered is what the user actually typed before prepending a
 * directory path. The reason for this is that if the user types
52 53
 * https://www.gimp.org/foo.png he wants to fetch a URL, and the full
 * pathname will not look like a URL.
54 55
 *
 * Returns: The output image.
56
 **/
57
gint32
58
gimp_file_load (GimpRunMode  run_mode,
59 60
                const gchar *filename,
                const gchar *raw_filename)
61 62 63 64 65
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint32 image_ID = -1;

66
  return_vals = gimp_run_procedure ("gimp-file-load",
67 68 69 70 71
                                    &nreturn_vals,
                                    GIMP_PDB_INT32, run_mode,
                                    GIMP_PDB_STRING, filename,
                                    GIMP_PDB_STRING, raw_filename,
                                    GIMP_PDB_END);
72 73 74 75 76 77 78 79 80

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    image_ID = return_vals[1].data.d_image;

  gimp_destroy_params (return_vals, nreturn_vals);

  return image_ID;
}

81 82 83 84 85 86
/**
 * gimp_file_load_layer:
 * @run_mode: The run mode.
 * @image_ID: Destination image.
 * @filename: The name of the file to load.
 *
87
 * Loads an image file as a layer for an existing image.
88 89
 *
 * This procedure behaves like the file-load procedure but opens the
90
 * specified image as a layer for an existing image. The returned layer
91 92
 * needs to be added to the existing image with
 * gimp_image_insert_layer().
93 94 95
 *
 * Returns: The layer created when loading the image file.
 *
96
 * Since: 2.4
97
 **/
98 99
gint32
gimp_file_load_layer (GimpRunMode  run_mode,
100 101
                      gint32       image_ID,
                      const gchar *filename)
102 103 104 105 106 107
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint32 layer_ID = -1;

  return_vals = gimp_run_procedure ("gimp-file-load-layer",
108 109 110 111 112
                                    &nreturn_vals,
                                    GIMP_PDB_INT32, run_mode,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_STRING, filename,
                                    GIMP_PDB_END);
113 114 115 116 117 118 119 120 121

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    layer_ID = return_vals[1].data.d_layer;

  gimp_destroy_params (return_vals, nreturn_vals);

  return layer_ID;
}

122 123 124 125 126 127 128 129 130 131 132
/**
 * gimp_file_load_layers:
 * @run_mode: The run mode.
 * @image_ID: Destination image.
 * @filename: The name of the file to load.
 * @num_layers: The number of loaded layers.
 *
 * Loads an image file as layers for an existing image.
 *
 * This procedure behaves like the file-load procedure but opens the
 * specified image as layers for an existing image. The returned layers
133 134
 * needs to be added to the existing image with
 * gimp_image_insert_layer().
135 136 137
 *
 * Returns: The list of loaded layers.
 *
138
 * Since: 2.4
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
gint *
gimp_file_load_layers (GimpRunMode  run_mode,
                       gint32       image_ID,
                       const gchar *filename,
                       gint        *num_layers)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gint *layer_ids = NULL;

  return_vals = gimp_run_procedure ("gimp-file-load-layers",
                                    &nreturn_vals,
                                    GIMP_PDB_INT32, run_mode,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_STRING, filename,
                                    GIMP_PDB_END);

  *num_layers = 0;

  if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
    {
      *num_layers = return_vals[1].data.d_int32;
      layer_ids = g_new (gint32, *num_layers);
      memcpy (layer_ids,
              return_vals[2].data.d_int32array,
              *num_layers * sizeof (gint32));
    }

  gimp_destroy_params (return_vals, nreturn_vals);

  return layer_ids;
}

173 174 175 176 177 178
/**
 * gimp_file_save:
 * @run_mode: The run mode.
 * @image_ID: Input image.
 * @drawable_ID: Drawable to save.
 * @filename: The name of the file to save the image in.
179
 * @raw_filename: The name as entered by the user.
180 181 182 183 184 185 186
 *
 * Saves a file by extension.
 *
 * This procedure invokes the correct file save handler according to
 * the file's extension and/or prefix. The name of the file to save is
 * typically a full pathname, and the name entered is what the user
 * actually typed before prepending a directory path. The reason for
187 188 189
 * this is that if the user types https://www.gimp.org/foo.png she
 * wants to fetch a URL, and the full pathname will not look like a
 * URL.
190 191
 *
 * Returns: TRUE on success.
192
 **/
193
gboolean
194
gimp_file_save (GimpRunMode  run_mode,
195 196 197 198
                gint32       image_ID,
                gint32       drawable_ID,
                const gchar *filename,
                const gchar *raw_filename)
199 200 201 202 203
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

204
  return_vals = gimp_run_procedure ("gimp-file-save",
205 206 207 208 209 210 211
                                    &nreturn_vals,
                                    GIMP_PDB_INT32, run_mode,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_DRAWABLE, drawable_ID,
                                    GIMP_PDB_STRING, filename,
                                    GIMP_PDB_STRING, raw_filename,
                                    GIMP_PDB_END);
212 213 214 215

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

  return success;
}

/**
 * gimp_file_save_thumbnail:
 * @image_ID: The image.
 * @filename: The name of the file the thumbnail belongs to.
 *
 * Saves a thumbnail for the given image
 *
 * This procedure saves a thumbnail for the given image according to
 * the Free Desktop Thumbnail Managing Standard. The thumbnail is saved
 * so that it belongs to the file with the given filename. This means
 * you have to save the image under this name first, otherwise this
 * procedure will fail. This procedure may become useful if you want to
232
 * explicitly save a thumbnail with a file.
233 234
 *
 * Returns: TRUE on success.
235
 **/
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
gboolean
gimp_file_save_thumbnail (gint32       image_ID,
                          const gchar *filename)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

  return_vals = gimp_run_procedure ("gimp-file-save-thumbnail",
                                    &nreturn_vals,
                                    GIMP_PDB_IMAGE, image_ID,
                                    GIMP_PDB_STRING, filename,
                                    GIMP_PDB_END);

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);
253 254 255 256

  return success;
}

257 258 259 260 261 262 263 264 265 266
/**
 * gimp_register_magic_load_handler:
 * @procedure_name: The name of the procedure to be used for loading.
 * @extensions: comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
 * @prefixes: comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
 * @magics: comma separated list of magic file information this handler can load (i.e. \"0,string,GIF\").
 *
 * Registers a file load handler procedure.
 *
 * Registers a procedural database procedure to be called to load files
267
 * of a particular file format using magic file information.
268 269
 *
 * Returns: TRUE on success.
270
 **/
271
gboolean
272
gimp_register_magic_load_handler (const gchar *procedure_name,
273 274 275
                                  const gchar *extensions,
                                  const gchar *prefixes,
                                  const gchar *magics)
276
{
277
  GimpParam *return_vals;
278
  gint nreturn_vals;
279
  gboolean success = TRUE;
280

281
  return_vals = gimp_run_procedure ("gimp-register-magic-load-handler",
282 283 284 285 286 287
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
                                    GIMP_PDB_STRING, extensions,
                                    GIMP_PDB_STRING, prefixes,
                                    GIMP_PDB_STRING, magics,
                                    GIMP_PDB_END);
288

289 290
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

291
  gimp_destroy_params (return_vals, nreturn_vals);
292 293

  return success;
294 295
}

296 297 298 299 300 301 302 303 304
/**
 * gimp_register_load_handler:
 * @procedure_name: The name of the procedure to be used for loading.
 * @extensions: comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").
 * @prefixes: comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").
 *
 * Registers a file load handler procedure.
 *
 * Registers a procedural database procedure to be called to load files
305
 * of a particular file format.
306 307
 *
 * Returns: TRUE on success.
308
 **/
309
gboolean
310
gimp_register_load_handler (const gchar *procedure_name,
311 312
                            const gchar *extensions,
                            const gchar *prefixes)
313
{
314
  GimpParam *return_vals;
315
  gint nreturn_vals;
316
  gboolean success = TRUE;
317

318
  return_vals = gimp_run_procedure ("gimp-register-load-handler",
319 320 321 322 323
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
                                    GIMP_PDB_STRING, extensions,
                                    GIMP_PDB_STRING, prefixes,
                                    GIMP_PDB_END);
324

325 326
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

327
  gimp_destroy_params (return_vals, nreturn_vals);
328 329

  return success;
330 331
}

332 333 334 335 336 337 338 339 340
/**
 * gimp_register_save_handler:
 * @procedure_name: The name of the procedure to be used for saving.
 * @extensions: comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\").
 * @prefixes: comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\").
 *
 * Registers a file save handler procedure.
 *
 * Registers a procedural database procedure to be called to save files
341
 * in a particular file format.
342 343
 *
 * Returns: TRUE on success.
344
 **/
345
gboolean
346
gimp_register_save_handler (const gchar *procedure_name,
347 348
                            const gchar *extensions,
                            const gchar *prefixes)
349
{
350
  GimpParam *return_vals;
351
  gint nreturn_vals;
352
  gboolean success = TRUE;
353

354
  return_vals = gimp_run_procedure ("gimp-register-save-handler",
355 356 357 358 359
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
                                    GIMP_PDB_STRING, extensions,
                                    GIMP_PDB_STRING, prefixes,
                                    GIMP_PDB_END);
360

361 362
  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

363
  gimp_destroy_params (return_vals, nreturn_vals);
364 365

  return success;
366
}
367 368 369 370

/**
 * gimp_register_file_handler_mime:
 * @procedure_name: The name of the procedure to associate a MIME type with.
371
 * @mime_types: A comma-separated list of MIME types, such as \"image/jpeg\".
372
 *
373
 * Associates MIME types with a file handler procedure.
374
 *
375
 * Registers MIME types for a file handler procedure. This allows GIMP
376
 * to determine the MIME type of the file opened or saved using this
377 378 379
 * procedure. It is recommended that only one MIME type is registered
 * per file procedure; when registering more than one MIME type, GIMP
 * will associate the first one with files opened or saved with this
380 381 382 383
 * procedure.
 *
 * Returns: TRUE on success.
 *
384
 * Since: 2.2
385
 **/
386 387
gboolean
gimp_register_file_handler_mime (const gchar *procedure_name,
388
                                 const gchar *mime_types)
389 390 391 392 393
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

394
  return_vals = gimp_run_procedure ("gimp-register-file-handler-mime",
395 396
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
397
                                    GIMP_PDB_STRING, mime_types,
398
                                    GIMP_PDB_END);
399 400 401 402 403 404 405

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}
406

407 408 409 410 411 412 413 414 415 416 417 418 419
/**
 * gimp_register_file_handler_uri:
 * @procedure_name: The name of the procedure to enable URIs for.
 *
 * Registers a file handler procedure as capable of handling URIs.
 *
 * Registers a file handler procedure as capable of handling URIs. This
 * allows GIMP to call the procecure directly for all kinds of URIs,
 * and the 'filename' traditionally passed to file procesures turns
 * into an URI.
 *
 * Returns: TRUE on success.
 *
420
 * Since: 2.10
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
 **/
gboolean
gimp_register_file_handler_uri (const gchar *procedure_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

  return_vals = gimp_run_procedure ("gimp-register-file-handler-uri",
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
                                    GIMP_PDB_END);

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

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
/**
 * gimp_register_file_handler_raw:
 * @procedure_name: The name of the procedure to enable raw handling for.
 *
 * Registers a file handler procedure as capable of handling raw camera
 * files.
 *
 * Registers a file handler procedure as capable of handling raw
 * digital camera files. Use this procedure only to register raw load
 * handlers, calling it on a save handler will generate an error.
 *
 * Returns: TRUE on success.
 *
 * Since: 2.10
 **/
gboolean
gimp_register_file_handler_raw (const gchar *procedure_name)
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

  return_vals = gimp_run_procedure ("gimp-register-file-handler-raw",
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, procedure_name,
                                    GIMP_PDB_END);

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
/**
 * gimp_register_thumbnail_loader:
 * @load_proc: The name of the procedure the thumbnail loader with.
 * @thumb_proc: The name of the thumbnail load procedure.
 *
 * Associates a thumbnail loader with a file load procedure.
 *
 * Some file formats allow for embedded thumbnails, other file formats
 * contain a scalable image or provide the image data in different
 * resolutions. A file plug-in for such a format may register a special
 * procedure that allows GIMP to load a thumbnail preview of the image.
 * This procedure is then associated with the standard load procedure
 * using this function.
 *
 * Returns: TRUE on success.
 *
491
 * Since: 2.2
492
 **/
493 494
gboolean
gimp_register_thumbnail_loader (const gchar *load_proc,
495
                                const gchar *thumb_proc)
496 497 498 499 500
{
  GimpParam *return_vals;
  gint nreturn_vals;
  gboolean success = TRUE;

501
  return_vals = gimp_run_procedure ("gimp-register-thumbnail-loader",
502 503 504 505
                                    &nreturn_vals,
                                    GIMP_PDB_STRING, load_proc,
                                    GIMP_PDB_STRING, thumb_proc,
                                    GIMP_PDB_END);
506 507 508 509 510 511 512

  success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;

  gimp_destroy_params (return_vals, nreturn_vals);

  return success;
}