gimp/app/plug-in/gimpplugin-progress.c

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 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.
 */

#include "config.h"

#include <glib-object.h>

#include "plug-in-types.h"

#include "core/gimp.h"
#include "core/gimpprogress.h"

#include "pdb/procedural_db.h"

#include "plug-in.h"
#include "plug-in-progress.h"


/*  local function prototypes  */

static void   plug_in_progress_cancel (GimpProgress *progress,
                                       PlugIn       *plug_in);


/*  public functions  */

void
plug_in_progress_start (PlugIn      *plug_in,
                        const gchar *message,
                        gint         display_ID)
{
  g_return_if_fail (plug_in != NULL);

  if (! message)
    message = plug_in->prog;

  if (! plug_in->progress)
    {
      plug_in->progress = gimp_new_progress (plug_in->gimp, display_ID);

      if (plug_in->progress)
        {
          plug_in->progress_created = TRUE;

          g_object_add_weak_pointer (G_OBJECT (plug_in->progress),
                                     (gpointer *) &plug_in->progress);
        }
    }

  if (plug_in->progress)
    {
      if (! plug_in->progress_cancel_id)
        plug_in->progress_cancel_id =
          g_signal_connect (plug_in->progress, "cancel",
                            G_CALLBACK (plug_in_progress_cancel),
                            plug_in);

      if (gimp_progress_is_active (plug_in->progress))
        {
          gimp_progress_set_text (plug_in->progress, message);
          gimp_progress_set_value (plug_in->progress, 0.0);
        }
      else
        {
          gimp_progress_start (plug_in->progress, message, TRUE);
        }
    }
}

void
plug_in_progress_update (PlugIn  *plug_in,
			 gdouble  percentage)
{
  g_return_if_fail (plug_in != NULL);

  if (! plug_in->progress                           ||
      ! gimp_progress_is_active (plug_in->progress) ||
      ! plug_in->progress_cancel_id)
    {
      plug_in_progress_start (plug_in, NULL, -1);
    }

  if (plug_in->progress && gimp_progress_is_active (plug_in->progress))
    gimp_progress_set_value (plug_in->progress, percentage);
}

void
plug_in_progress_end (PlugIn *plug_in)
{
  g_return_if_fail (plug_in != NULL);

  if (plug_in->progress)
    {
      if (plug_in->progress_cancel_id)
        {
          g_signal_handler_disconnect (plug_in->progress,
                                       plug_in->progress_cancel_id);
          plug_in->progress_cancel_id = 0;
        }

      if (gimp_progress_is_active (plug_in->progress))
        gimp_progress_end (plug_in->progress);

      if (plug_in->progress_created)
        {
          gimp_free_progress (plug_in->gimp, plug_in->progress);
          plug_in->progress = NULL;
        }
    }
}


/*  private functions  */

static void
plug_in_progress_cancel (GimpProgress *progress,
			 PlugIn       *plug_in)
{
  if (plug_in->recurse_main_loop || plug_in->temp_main_loops)
    {
      plug_in->return_vals   = g_new (Argument, 1);
      plug_in->n_return_vals = 1;

      plug_in->return_vals->arg_type      = GIMP_PDB_STATUS;
      plug_in->return_vals->value.pdb_int = GIMP_PDB_CANCEL;
    }

  plug_in_close (plug_in, TRUE);
  plug_in_unref (plug_in);
}