gimp/app/pdb/fileops_cmds.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995-2003 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 2 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/* NOTE: This file is autogenerated by pdbgen.pl. */

#include "config.h"

#include <gdk-pixbuf/gdk-pixbuf.h>

#include <glib.h>

#ifdef G_OS_WIN32
#include <process.h>
#endif

#include <string.h>
#include <sys/types.h>

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif


#include <glib-object.h>

#include "libgimpbase/gimpbasetypes.h"

#include "pdb-types.h"
#include "procedural_db.h"

#include "base/temp-buf.h"
#include "config/gimpbaseconfig.h"
#include "config/gimpconfig-path.h"
#include "core/gimp.h"
#include "core/gimpimage.h"
#include "core/gimpimagefile.h"
#include "file/file-utils.h"
#include "plug-in/plug-in-proc.h"
#include "plug-in/plug-in.h"
#include "plug-in/plug-ins.h"

#include "libgimpthumb/gimpthumb.h"

static ProcRecord file_load_proc;
static ProcRecord file_save_proc;
static ProcRecord file_load_thumbnail_proc;
static ProcRecord file_save_thumbnail_proc;
static ProcRecord temp_name_proc;
static ProcRecord register_magic_load_handler_proc;
static ProcRecord register_load_handler_proc;
static ProcRecord register_save_handler_proc;

void
register_fileops_procs (Gimp *gimp)
{
  procedural_db_register (gimp, &file_load_proc);
  procedural_db_register (gimp, &file_save_proc);
  procedural_db_register (gimp, &file_load_thumbnail_proc);
  procedural_db_register (gimp, &file_save_thumbnail_proc);
  procedural_db_register (gimp, &temp_name_proc);
  procedural_db_register (gimp, &register_magic_load_handler_proc);
  procedural_db_register (gimp, &register_load_handler_proc);
  procedural_db_register (gimp, &register_save_handler_proc);
}

static Argument *
file_load_invoker (Gimp        *gimp,
                   GimpContext *context,
                   Argument    *args)
{
  Argument *new_args;
  Argument *return_vals;
  PlugInProcDef *file_proc;
  const ProcRecord *proc;
  gchar *uri;
  gint i;

  uri = file_utils_filename_to_uri (gimp->load_procs, (gchar *) args[1].value.pdb_pointer, NULL);

  if (! uri)
    return procedural_db_return_args (&file_load_proc, FALSE);

  file_proc = file_utils_find_proc (gimp->load_procs, uri);

  g_free (uri);

  if (! file_proc)
    return procedural_db_return_args (&file_load_proc, FALSE);

  proc = plug_in_proc_def_get_proc (file_proc);

  new_args = g_new0 (Argument, proc->num_args);
  memcpy (new_args, args, sizeof (Argument) * 3);

  for (i = 3; i < proc->num_args; i++)
    {
      new_args[i].arg_type = proc->args[i].arg_type;
      if (proc->args[i].arg_type == GIMP_PDB_STRING)
        new_args[i].value.pdb_pointer = g_strdup ("");
    }

  return_vals = procedural_db_execute (gimp, context, proc->name, new_args);
  g_free (new_args);

  return return_vals;
}

static ProcArg file_load_inargs[] =
{
  {
    GIMP_PDB_INT32,
    "run_mode",
    "The run mode: GIMP_RUN_INTERACTIVE (0) or GIMP_RUN_NONINTERACTIVE (1)"
  },
  {
    GIMP_PDB_STRING,
    "filename",
    "The name of the file to load"
  },
  {
    GIMP_PDB_STRING,
    "raw_filename",
    "The name as entered by the user"
  }
};

static ProcArg file_load_outargs[] =
{
  {
    GIMP_PDB_IMAGE,
    "image",
    "The output image"
  }
};

static ProcRecord file_load_proc =
{
  "gimp_file_load",
  "Loads a file by extension.",
  "This procedure invokes the correct file load handler according to the file's extension and/or prefix. 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 http://www.xcf/~gimp/ he wants to fetch a URL, and the full pathname will not look like a URL.",
  "Josh MacDonald",
  "Josh MacDonald",
  "1997",
  GIMP_INTERNAL,
  3,
  file_load_inargs,
  1,
  file_load_outargs,
  { { file_load_invoker } }
};

static Argument *
file_save_invoker (Gimp        *gimp,
                   GimpContext *context,
                   Argument    *args)
{
  Argument *new_args;
  Argument *return_vals;
  PlugInProcDef *file_proc;
  const ProcRecord *proc;
  gchar *uri;
  gint i;

  uri = file_utils_filename_to_uri (gimp->load_procs, (gchar *) args[3].value.pdb_pointer, NULL);

  if (! uri)
    return procedural_db_return_args (&file_save_proc, FALSE);

  file_proc = file_utils_find_proc (gimp->save_procs, uri);

  g_free (uri);

  if (! file_proc) 
    return procedural_db_return_args (&file_save_proc, FALSE);

  proc = plug_in_proc_def_get_proc (file_proc);

  new_args = g_new0 (Argument, proc->num_args);
  memcpy (new_args, args, sizeof (Argument) * 5);

  for (i = 5; i < proc->num_args; i++)
    {
      new_args[i].arg_type = proc->args[i].arg_type;
      if (proc->args[i].arg_type == GIMP_PDB_STRING)
        new_args[i].value.pdb_pointer = g_strdup ("");
    }

  return_vals = procedural_db_execute (gimp, context, proc->name, new_args);
  g_free (new_args);

  return return_vals;
}

static ProcArg file_save_inargs[] =
{
  {
    GIMP_PDB_INT32,
    "run_mode",
    "The run mode: GIMP_RUN_INTERACTIVE (0) or GIMP_RUN_NONINTERACTIVE (1)"
  },
  {
    GIMP_PDB_IMAGE,
    "image",
    "Input image"
  },
  {
    GIMP_PDB_DRAWABLE,
    "drawable",
    "Drawable to save"
  },
  {
    GIMP_PDB_STRING,
    "filename",
    "The name of the file to save the image in"
  },
  {
    GIMP_PDB_STRING,
    "raw_filename",
    "The name as entered by the user"
  }
};

static ProcRecord file_save_proc =
{
  "gimp_file_save",
  "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 this is that if the user types http://www.xcf/~gimp/ she wants to fetch a URL, and the full pathname will not look like a URL.",
  "Josh MacDonald",
  "Josh MacDonald",
  "1997",
  GIMP_INTERNAL,
  5,
  file_save_inargs,
  0,
  NULL,
  { { file_save_invoker } }
};

static Argument *
file_load_thumbnail_invoker (Gimp        *gimp,
                             GimpContext *context,
                             Argument    *args)
{
  gboolean success = TRUE;
  Argument *return_args;
  gchar *filename;
  gint32 width = 0;
  gint32 height = 0;
  gint32 num_bytes = 0;
  guint8 *thumb_data = NULL;
  gchar *uri;
  GimpThumbnail *thumbnail = NULL;
  GdkPixbuf *pixbuf = NULL;

  filename = (gchar *) args[0].value.pdb_pointer;
  if (filename == NULL)
    success = FALSE;

  if (success)
    {
      uri = g_filename_to_uri (filename, NULL, NULL);

      if (uri)
        {
          thumbnail = gimp_thumbnail_new ();
          gimp_thumbnail_set_uri (thumbnail, uri);

          pixbuf = gimp_thumbnail_load_thumb (thumbnail,
                                              GIMP_THUMBNAIL_SIZE_NORMAL,
                                              NULL);
        }

      if (pixbuf)
        {
          width  = gdk_pixbuf_get_width (pixbuf);
          height = gdk_pixbuf_get_height (pixbuf);

          if (gdk_pixbuf_get_n_channels (pixbuf) != 3)
            {
              GdkPixbuf *tmp = gdk_pixbuf_new (GDK_COLORSPACE_RGB, FALSE, 8,
                                               width, height);

              gdk_pixbuf_composite_color (pixbuf, tmp,
                                          0, 0, width, height, 0, 0, 1.0, 1.0,
                                          GDK_INTERP_NEAREST, 255,
                                          0, 0, GIMP_SMALL_CHECKS,
                                          0x66666666, 0x99999999);

              g_object_unref (pixbuf);
              pixbuf = tmp;
            }

          num_bytes  = 3 * width * height;
          thumb_data = g_memdup (gdk_pixbuf_get_pixels (pixbuf), num_bytes);

          g_object_unref (pixbuf);

          success = TRUE;
        }
      else
        {
          success = FALSE;
        }

        g_free (uri);
    }

  return_args = procedural_db_return_args (&file_load_thumbnail_proc, success);

  if (success)
    {
      return_args[1].value.pdb_int = width;
      return_args[2].value.pdb_int = height;
      return_args[3].value.pdb_int = num_bytes;
      return_args[4].value.pdb_pointer = thumb_data;
    }

  return return_args;
}

static ProcArg file_load_thumbnail_inargs[] =
{
  {
    GIMP_PDB_STRING,
    "filename",
    "The name of the file that owns the thumbnail to load"
  }
};

static ProcArg file_load_thumbnail_outargs[] =
{
  {
    GIMP_PDB_INT32,
    "width",
    "The width of the thumbnail"
  },
  {
    GIMP_PDB_INT32,
    "height",
    "The height of the thumbnail"
  },
  {
    GIMP_PDB_INT32,
    "thumbnail_data_count",
    "The number of bytes in thumbnail data"
  },
  {
    GIMP_PDB_INT8ARRAY,
    "thumb_data",
    "The thumbnail data"
  }
};

static ProcRecord file_load_thumbnail_proc =
{
  "gimp_file_load_thumbnail",
  "Loads the thumbnail for a file.",
  "This procedure tries to load a thumbnail that belongs to the file with the given filename. This name is a full pathname. The returned data is an array of colordepth 3 (RGB), regardless of the image type. Width and height of the thumbnail are also returned. Don't use this function if you need a thumbnail of an already opened image, use gimp_image_thumbnail instead.",
  "Adam D. Moss, Sven Neumann",
  "Adam D. Moss, Sven Neumann",
  "1999-2003",
  GIMP_INTERNAL,
  1,
  file_load_thumbnail_inargs,
  4,
  file_load_thumbnail_outargs,
  { { file_load_thumbnail_invoker } }
};

static Argument *
file_save_thumbnail_invoker (Gimp        *gimp,
                             GimpContext *context,
                             Argument    *args)
{
  gboolean success = TRUE;
  GimpImage *gimage;
  gchar *filename;
  GimpImagefile *imagefile;
  gchar *uri;
  const gchar *image_uri;

  gimage = gimp_image_get_by_ID (gimp, args[0].value.pdb_int);
  if (! GIMP_IS_IMAGE (gimage))
    success = FALSE;

  filename = (gchar *) args[1].value.pdb_pointer;
  if (filename == NULL)
    success = FALSE;

  if (success)
    {
      image_uri = gimp_object_get_name (GIMP_OBJECT (gimage));
      if (! image_uri)
        success = FALSE;

      if (success)
        {
          uri = g_filename_to_uri (filename, NULL, NULL);
          if (! uri)
            success = FALSE;

          if (success)
            {
              if (strcmp (uri, image_uri))
                success = FALSE;

              if (success)
                {
                  imagefile = gimp_imagefile_new (gimp, uri);
                  success = gimp_imagefile_save_thumbnail (imagefile, gimage);
                  g_object_unref (imagefile);
                }

              g_free (uri);
            }
        }
    }

  return procedural_db_return_args (&file_save_thumbnail_proc, success);
}

static ProcArg file_save_thumbnail_inargs[] =
{
  {
    GIMP_PDB_IMAGE,
    "image",
    "The image"
  },
  {
    GIMP_PDB_STRING,
    "filename",
    "The name of the file the thumbnail belongs to"
  }
};

static ProcRecord file_save_thumbnail_proc =
{
  "gimp_file_save_thumbnail",
  "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 explicitely save a thumbnail with a file.",
  "Josh MacDonald",
  "Josh MacDonald",
  "1997",
  GIMP_INTERNAL,
  2,
  file_save_thumbnail_inargs,
  0,
  NULL,
  { { file_save_thumbnail_invoker } }
};

static Argument *
temp_name_invoker (Gimp        *gimp,
                   GimpContext *context,
                   Argument    *args)
{
  gboolean success = TRUE;
  Argument *return_args;
  gchar *extension;
  gchar *name = NULL;
  static gint id = 0;
  static gint pid;
  gchar *filename;
  gchar *path;

  extension = (gchar *) args[0].value.pdb_pointer;
  if (extension == NULL)
    success = FALSE;

  if (success)
    {
      if (id == 0)
        pid = getpid ();

      filename = g_strdup_printf ("gimp_temp_%d%d.%s",
                                  pid, id++, extension);

      path = gimp_config_path_expand (GIMP_BASE_CONFIG (gimp->config)->temp_path,
                                      TRUE, NULL);

      name = g_build_filename (path, filename, NULL);

      g_free (path);
      g_free (filename);
    }

  return_args = procedural_db_return_args (&temp_name_proc, success);

  if (success)
    return_args[1].value.pdb_pointer = name;

  return return_args;
}

static ProcArg temp_name_inargs[] =
{
  {
    GIMP_PDB_STRING,
    "extension",
    "The extension the file will have"
  }
};

static ProcArg temp_name_outargs[] =
{
  {
    GIMP_PDB_STRING,
    "name",
    "The new temp filename"
  }
};

static ProcRecord temp_name_proc =
{
  "gimp_temp_name",
  "Generates a unique filename.",
  "Generates a unique filename using the temp path supplied in the user's gimprc.",
  "Josh MacDonald",
  "Josh MacDonald",
  "1997",
  GIMP_INTERNAL,
  1,
  temp_name_inargs,
  1,
  temp_name_outargs,
  { { temp_name_invoker } }
};

static Argument *
register_magic_load_handler_invoker (Gimp        *gimp,
                                     GimpContext *context,
                                     Argument    *args)
{
  gboolean success = TRUE;
  gchar *name;
  gchar *extensions;
  gchar *prefixes;
  gchar *magics;
  ProcRecord *proc;
  PlugInProcDef *file_proc;

  name = (gchar *) args[0].value.pdb_pointer;
  if (name == NULL || !g_utf8_validate (name, -1, NULL))
    success = FALSE;

  extensions = (gchar *) args[1].value.pdb_pointer;

  prefixes = (gchar *) args[2].value.pdb_pointer;

  magics = (gchar *) args[3].value.pdb_pointer;

  if (success)
    {
      success = FALSE;

      proc = procedural_db_lookup (gimp, name);

      if (proc && ((proc->num_args < 3) ||
                   (proc->num_values < 1) ||
                   (proc->args[0].arg_type != GIMP_PDB_INT32) ||
                   (proc->args[1].arg_type != GIMP_PDB_STRING) ||
                   (proc->args[2].arg_type != GIMP_PDB_STRING) ||
                   (proc->values[0].arg_type != GIMP_PDB_IMAGE)))
        {
          g_message ("load handler \"%s\" does not take the standard load handler args",
                     name);
          goto done;
        }

      file_proc = plug_ins_file_handler (gimp, name, extensions, prefixes, magics);

      if (! file_proc)
        {
          g_message ("attempt to register non-existant load handler \"%s\"",
                     name);
          goto done;
        }

      if (! g_slist_find (gimp->load_procs, file_proc))
        gimp->load_procs = g_slist_prepend (gimp->load_procs, file_proc);

      success = TRUE;

    done: ;
    }

  return procedural_db_return_args (&register_magic_load_handler_proc, success);
}

static ProcArg register_magic_load_handler_inargs[] =
{
  {
    GIMP_PDB_STRING,
    "procedure_name",
    "The name of the procedure to be used for loading"
  },
  {
    GIMP_PDB_STRING,
    "extensions",
    "comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\")"
  },
  {
    GIMP_PDB_STRING,
    "prefixes",
    "comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\")"
  },
  {
    GIMP_PDB_STRING,
    "magics",
    "comma separated list of magic file information this handler can load (i.e. \"0,string,GIF\")"
  }
};

static ProcRecord register_magic_load_handler_proc =
{
  "gimp_register_magic_load_handler",
  "Registers a file load handler procedure.",
  "Registers a procedural database procedure to be called to load files of a particular file format using magic file information. The procedure you use must have a <Load> menu path associated with it.",
  "Spencer Kimball & Peter Mattis",
  "Spencer Kimball & Peter Mattis",
  "1995-1996",
  GIMP_INTERNAL,
  4,
  register_magic_load_handler_inargs,
  0,
  NULL,
  { { register_magic_load_handler_invoker } }
};

static Argument *
register_load_handler_invoker (Gimp        *gimp,
                               GimpContext *context,
                               Argument    *args)
{
  int i;
  Argument argv[4];

  for (i = 0; i < 3; i++)
    argv[i] = args[i];

  argv[3].arg_type = GIMP_PDB_STRING;
  argv[3].value.pdb_pointer = NULL;

  return register_magic_load_handler_invoker (gimp, context, argv);
}

static ProcArg register_load_handler_inargs[] =
{
  {
    GIMP_PDB_STRING,
    "procedure_name",
    "The name of the procedure to be used for loading"
  },
  {
    GIMP_PDB_STRING,
    "extensions",
    "comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\")"
  },
  {
    GIMP_PDB_STRING,
    "prefixes",
    "comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\")"
  }
};

static ProcRecord register_load_handler_proc =
{
  "gimp_register_load_handler",
  "Registers a file load handler procedure.",
  "Registers a procedural database procedure to be called to load files of a particular file format. The procedure you use must have a <Load> menu path associated with it.",
  "Spencer Kimball & Peter Mattis",
  "Spencer Kimball & Peter Mattis",
  "1995-1996",
  GIMP_INTERNAL,
  3,
  register_load_handler_inargs,
  0,
  NULL,
  { { register_load_handler_invoker } }
};

static Argument *
register_save_handler_invoker (Gimp        *gimp,
                               GimpContext *context,
                               Argument    *args)
{
  gboolean success = TRUE;
  gchar *name;
  gchar *extensions;
  gchar *prefixes;
  ProcRecord *proc;
  PlugInProcDef *file_proc;

  name = (gchar *) args[0].value.pdb_pointer;
  if (name == NULL || !g_utf8_validate (name, -1, NULL))
    success = FALSE;

  extensions = (gchar *) args[1].value.pdb_pointer;

  prefixes = (gchar *) args[2].value.pdb_pointer;

  if (success)
    {
      success = FALSE;

      proc = procedural_db_lookup (gimp, name);

      if (proc && ((proc->num_args < 5) ||
                   (proc->args[0].arg_type != GIMP_PDB_INT32) ||
                   (proc->args[1].arg_type != GIMP_PDB_IMAGE) ||
                   (proc->args[2].arg_type != GIMP_PDB_DRAWABLE) ||
                   (proc->args[3].arg_type != GIMP_PDB_STRING) ||
                   (proc->args[4].arg_type != GIMP_PDB_STRING)))
        {
          g_message ("save handler \"%s\" does not take the standard save handler args",
                     name);
          goto done;
        }

      file_proc = plug_ins_file_handler (gimp, name, extensions, prefixes, NULL);

      if (! file_proc)
        {
          g_message ("attempt to register non-existant save handler \"%s\"",
                     name);
          goto done;
        }

      if (! g_slist_find (gimp->save_procs, file_proc))
        gimp->save_procs = g_slist_prepend (gimp->save_procs, file_proc);

      success = TRUE;

    done: ;
    }

  return procedural_db_return_args (&register_save_handler_proc, success);
}

static ProcArg register_save_handler_inargs[] =
{
  {
    GIMP_PDB_STRING,
    "procedure_name",
    "The name of the procedure to be used for saving"
  },
  {
    GIMP_PDB_STRING,
    "extensions",
    "comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\")"
  },
  {
    GIMP_PDB_STRING,
    "prefixes",
    "comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\")"
  }
};

static ProcRecord register_save_handler_proc =
{
  "gimp_register_save_handler",
  "Registers a file save handler procedure.",
  "Registers a procedural database procedure to be called to save files in a particular file format. The procedure you use must have a <Save> menu path associated with it.",
  "Spencer Kimball & Peter Mattis",
  "Spencer Kimball & Peter Mattis",
  "1995-1996",
  GIMP_INTERNAL,
  3,
  register_save_handler_inargs,
  0,
  NULL,
  { { register_save_handler_invoker } }
};