gimp/libgimp/gimploadprocedure.h

/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * gimploadprocedure.h
 * Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see
 * <https://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_LOAD_PROCEDURE_H__
#define __GIMP_LOAD_PROCEDURE_H__

#include <libgimp/gimpfileprocedure.h>

G_BEGIN_DECLS

/* For information look into the C source or the html documentation */


/**
 * GimpLoadFunc:
 * @procedure:   the #GimpProcedure that runs.
 * @run_mode:    the #GimpRunMode.
 * @file:        the #GFile to load from.
 * @args:        the @procedure's remaining arguments.
 * @run_data:    the run_data given in gimp_load_procedure_new().
 *
 * The load function is run during the lifetime of the GIMP session,
 * each time a plug-in load procedure is called.
 *
 * Returns: (transfer full): the @procedure's return values.
 *
 * Since: 3.0
 **/
typedef GimpValueArray * (* GimpLoadFunc) (GimpProcedure        *procedure,
                                           GimpRunMode           run_mode,
                                           GFile                *file,
                                           const GimpValueArray *args,
                                           gpointer              run_data);


#define GIMP_TYPE_LOAD_PROCEDURE            (gimp_load_procedure_get_type ())
#define GIMP_LOAD_PROCEDURE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_LOAD_PROCEDURE, GimpLoadProcedure))
#define GIMP_LOAD_PROCEDURE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_LOAD_PROCEDURE, GimpLoadProcedureClass))
#define GIMP_IS_LOAD_PROCEDURE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_LOAD_PROCEDURE))
#define GIMP_IS_LOAD_PROCEDURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_LOAD_PROCEDURE))
#define GIMP_LOAD_PROCEDURE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_LOAD_PROCEDURE, GimpLoadProcedureClass))


typedef struct _GimpLoadProcedure        GimpLoadProcedure;
typedef struct _GimpLoadProcedureClass   GimpLoadProcedureClass;
typedef struct _GimpLoadProcedurePrivate GimpLoadProcedurePrivate;

struct _GimpLoadProcedure
{
  GimpFileProcedure         parent_instance;

  GimpLoadProcedurePrivate *priv;
};

struct _GimpLoadProcedureClass
{
  GimpFileProcedureClass parent_class;
};


GType           gimp_load_procedure_get_type             (void) G_GNUC_CONST;

GimpProcedure * gimp_load_procedure_new                  (GimpPlugIn        *plug_in,
                                                          const gchar       *name,
                                                          GimpPDBProcType    proc_type,
                                                          GimpLoadFunc       run_func,
                                                          gpointer           run_data,
                                                          GDestroyNotify     run_data_destroy);

void            gimp_load_procedure_set_handles_raw      (GimpLoadProcedure *procedure,
                                                          gboolean           handles_raw);
gboolean        gimp_load_procedure_get_handles_raw      (GimpLoadProcedure *procedure);

void            gimp_load_procedure_set_thumbnail_loader (GimpLoadProcedure *procedure,
                                                          const gchar       *thumbnail_proc);
const gchar   * gimp_load_procedure_get_thumbnail_loader (GimpLoadProcedure *procedure);


G_END_DECLS

#endif  /*  __GIMP_LOAD_PROCEDURE_H__  */