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
|
/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
*
* gimpprogress.c
*
* 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 2 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
* Library 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include <glib-object.h>
#undef GIMP_DISABLE_DEPRECATED
#include "gimpprogress.h"
#define GIMP_DISABLE_DEPRECATED
#include "gimp.h"
typedef struct
{
gchar *progress_callback;
GimpProgressVtable vtable;
gpointer data;
} GimpProgressData;
/* local function prototypes */
static void gimp_progress_data_free (GimpProgressData *data);
static void gimp_temp_progress_run (const gchar *name,
gint nparams,
const GimpParam *param,
gint *nreturn_vals,
GimpParam **return_vals);
/* private variables */
static GHashTable * gimp_progress_ht = NULL;
static gdouble gimp_progress_current = 0.0;
static const gdouble gimp_progress_step = (1.0 / 256.0);
/* public functions */
/**
* gimp_progress_install:
* @start_callback: the function to call when progress starts
* @end_callback: the function to call when progress finishes
* @text_callback: the function to call to change the text
* @value_callback: the function to call to change the value
* @user_data: a pointer that is returned when uninstalling the progress
*
* Return value: the name of the temporary procedure that's been installed
*
* Since: GIMP 2.2
*
* Note that since GIMP 2.4, @value_callback can be called with
* negative values. This is triggered by calls to gimp_progress_pulse().
* The callback should then implement a progress indicating business,
* e.g. by calling gtk_progress_bar_pulse().
**/
const gchar *
gimp_progress_install (GimpProgressStartCallback start_callback,
GimpProgressEndCallback end_callback,
GimpProgressTextCallback text_callback,
GimpProgressValueCallback value_callback,
gpointer user_data)
{
GimpProgressVtable vtable = { 0, };
g_return_val_if_fail (start_callback != NULL, NULL);
g_return_val_if_fail (end_callback != NULL, NULL);
g_return_val_if_fail (text_callback != NULL, NULL);
g_return_val_if_fail (value_callback != NULL, NULL);
vtable.start = start_callback;
vtable.end = end_callback;
vtable.set_text = text_callback;
vtable.set_value = value_callback;
return gimp_progress_install_vtable (&vtable, user_data);
}
/**
* gimp_progress_install_vtable:
* @vtable: a pointer to a @GimpProgressVtable.
* @user_data: a pointer that is passed as user_data to all vtable functions.
*
* Return value: the name of the temporary procedure that's been installed
*
* Since: GIMP 2.4
**/
const gchar *
gimp_progress_install_vtable (const GimpProgressVtable *vtable,
gpointer user_data)
{
static const GimpParamDef args[] =
{
{ GIMP_PDB_INT32, "command", "" },
{ GIMP_PDB_STRING, "text", "" },
{ GIMP_PDB_FLOAT, "value", "" }
};
static const GimpParamDef values[] =
{
{ GIMP_PDB_FLOAT, "value", "" }
};
gchar *progress_callback;
g_return_val_if_fail (vtable != NULL, NULL);
g_return_val_if_fail (vtable->start != NULL, NULL);
g_return_val_if_fail (vtable->end != NULL, NULL);
g_return_val_if_fail (vtable->set_text != NULL, NULL);
g_return_val_if_fail (vtable->set_value != NULL, NULL);
progress_callback = gimp_procedural_db_temp_name ();
gimp_install_temp_proc (progress_callback,
"Temporary progress callback procedure",
"",
"",
"",
"",
NULL,
"",
GIMP_TEMPORARY,
G_N_ELEMENTS (args), G_N_ELEMENTS (values),
args, values,
gimp_temp_progress_run);
if (_gimp_progress_install (progress_callback))
{
GimpProgressData *progress_data;
gimp_extension_enable (); /* Allow callbacks to be watched */
/* Now add to hash table so we can find it again */
if (! gimp_progress_ht)
{
gimp_progress_ht =
g_hash_table_new_full (g_str_hash, g_str_equal,
g_free,
(GDestroyNotify) gimp_progress_data_free);
}
progress_data = g_slice_new0 (GimpProgressData);
progress_data->progress_callback = progress_callback;
progress_data->vtable.start = vtable->start;
progress_data->vtable.end = vtable->end;
progress_data->vtable.set_text = vtable->set_text;
progress_data->vtable.set_value = vtable->set_value;
progress_data->vtable.pulse = vtable->pulse;
progress_data->vtable.get_window = vtable->get_window;
progress_data->data = user_data;
g_hash_table_insert (gimp_progress_ht, progress_callback, progress_data);
return progress_callback;
}
gimp_uninstall_temp_proc (progress_callback);
g_free (progress_callback);
return NULL;
}
/**
* gimp_progress_uninstall:
* @progress_callback: the name of the temporary procedure to uninstall
*
* Uninstalls a temporary progress procedure that was installed using
* gimp_progress_install().
*
* Return value: the @user_data that was passed to gimp_progress_install().
*
* Since: GIMP 2.2
**/
gpointer
gimp_progress_uninstall (const gchar *progress_callback)
{
GimpProgressData *progress_data;
gpointer user_data;
g_return_val_if_fail (progress_callback != NULL, NULL);
g_return_val_if_fail (gimp_progress_ht != NULL, NULL);
progress_data = g_hash_table_lookup (gimp_progress_ht, progress_callback);
if (! progress_data)
{
g_warning ("Can't find internal progress data");
return NULL;
}
_gimp_progress_uninstall (progress_callback);
gimp_uninstall_temp_proc (progress_callback);
user_data = progress_data->data;
g_hash_table_remove (gimp_progress_ht, progress_callback);
return user_data;
}
/**
* gimp_progress_init:
* @message: Message to use in the progress dialog.
*
* Initializes the progress bar for the current plug-in.
*
* Initializes the progress bar for the current plug-in. It is only
* valid to call this procedure from a plug-in.
*
* Returns: TRUE on success.
*/
gboolean
gimp_progress_init (const gchar *message)
{
gimp_progress_current = 0.0;
return _gimp_progress_init (message, gimp_default_display ());
}
/**
* gimp_progress_init_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
*
* Initializes the progress bar for the current plug-in.
*
* Initializes the progress bar for the current plug-in. It is only
* valid to call this procedure from a plug-in.
*
* Returns: %TRUE on success.
*
* Since: GIMP 2.4
**/
gboolean
gimp_progress_init_printf (const gchar *format,
...)
{
gchar *text;
gboolean retval;
va_list args;
g_return_val_if_fail (format != NULL, FALSE);
va_start (args, format);
text = g_strdup_vprintf (format, args);
va_end (args);
retval = gimp_progress_init (text);
g_free (text);
return retval;
}
/**
* gimp_progress_set_text_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
*
* Changes the text in the progress bar for the current plug-in.
*
* This function allows to change the text in the progress bar for the
* current plug-in. Unlike gimp_progress_init() it does not change the
* displayed value.
*
* Returns: %TRUE on success.
*
* Since: GIMP 2.4
**/
gboolean
gimp_progress_set_text_printf (const gchar *format,
...)
{
gchar *text;
gboolean retval;
va_list args;
g_return_val_if_fail (format != NULL, FALSE);
va_start (args, format);
text = g_strdup_vprintf (format, args);
va_end (args);
retval = gimp_progress_set_text (text);
g_free (text);
return retval;
}
/**
* gimp_progress_update:
* @percentage: Percentage of progress completed (in the range from 0.0 to 1.0).
*
* Updates the progress bar for the current plug-in.
*
* Returns: TRUE on success.
*/
gboolean
gimp_progress_update (gdouble percentage)
{
gboolean changed;
if (percentage <= 0.0)
{
changed = (gimp_progress_current != 0.0);
percentage = 0.0;
}
else if (percentage >= 1.0)
{
changed = (gimp_progress_current != 1.0);
percentage = 1.0;
}
else
{
changed =
(fabs (gimp_progress_current - percentage) > gimp_progress_step);
#ifdef GIMP_UNSTABLE
if (! changed)
{
static gboolean warned = FALSE;
static gint count = 0;
count++;
if (count > 3 && ! warned)
{
g_printerr ("%s is updating the progress too often\n",
g_get_prgname ());
warned = TRUE;
}
}
#endif
}
/* Suppress the update if the change was only marginal. */
if (! changed)
return TRUE;
gimp_progress_current = percentage;
return _gimp_progress_update (gimp_progress_current);
}
/* private functions */
static void
gimp_progress_data_free (GimpProgressData *data)
{
g_slice_free (GimpProgressData, data);
}
static void
gimp_temp_progress_run (const gchar *name,
gint nparams,
const GimpParam *param,
gint *nreturn_vals,
GimpParam **return_vals)
{
static GimpParam values[2];
GimpProgressData *progress_data;
*nreturn_vals = 1;
*return_vals = values;
values[0].type = GIMP_PDB_STATUS;
values[0].data.d_status = GIMP_PDB_SUCCESS;
progress_data = g_hash_table_lookup (gimp_progress_ht, name);
if (! progress_data)
{
g_warning ("Can't find internal progress data");
values[0].data.d_status = GIMP_PDB_EXECUTION_ERROR;
}
else
{
GimpProgressCommand command = param[0].data.d_int32;
switch (command)
{
case GIMP_PROGRESS_COMMAND_START:
progress_data->vtable.start (param[1].data.d_string,
param[2].data.d_float != 0.0,
progress_data->data);
break;
case GIMP_PROGRESS_COMMAND_END:
progress_data->vtable.end (progress_data->data);
break;
case GIMP_PROGRESS_COMMAND_SET_TEXT:
progress_data->vtable.set_text (param[1].data.d_string,
progress_data->data);
break;
case GIMP_PROGRESS_COMMAND_SET_VALUE:
progress_data->vtable.set_value (param[2].data.d_float,
progress_data->data);
break;
case GIMP_PROGRESS_COMMAND_PULSE:
if (progress_data->vtable.pulse)
progress_data->vtable.pulse (progress_data->data);
else
progress_data->vtable.set_value (-1, progress_data->data);
break;
case GIMP_PROGRESS_COMMAND_GET_WINDOW:
*nreturn_vals = 2;
values[1].type = GIMP_PDB_FLOAT;
if (progress_data->vtable.get_window)
values[1].data.d_float =
(gdouble) progress_data->vtable.get_window (progress_data->data);
else
values[1].data.d_float = 0;
break;
default:
values[0].data.d_status = GIMP_PDB_CALLING_ERROR;
break;
}
}
}
|