dc3e815ff0
Several types functions were using the wording "float" historically to mean double-precision, e.g. the float array type (which was in fact a double array). Or the scanner function gimp_scanner_parse_float() was in fact returning a double value. What if we wanted someday to actually add float (usually this naming means in C the single-precision IEEE 754 floating point representation) support? How would we name this? Now technically it's not entirely wrong (a double is still a floating point). So I've been wondering if that is because maybe we never planned to have float and double precision may be good enough for all usage in a plug-in API (which doesn't have to be as generic so the higher precision is enough)? But how can we be sure? Also we already had some functions using the wording double (e.g. gimp_procedure_add_double_argument()), so let's just go the safe route and use the accurate wording. The additional change in PDB is internal, but there too, I was also finding very confusing that we were naming double-precision float as 'float' type. So I took the opportunity to update this. It doesn't change any signature. In fact the whole commit doesn't change any type or code logic, only naming, except for one bug fix in the middle which I encountered while renaming: in gimp_scanner_parse_deprecated_color(), I discovered a hidden bug in scanning (color-hsv*) values, which was mistakenly using a double type for an array of float.
331 lines
8.1 KiB
Text
331 lines
8.1 KiB
Text
# GIMP - The GNU 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 3 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, see <https://www.gnu.org/licenses/>.
|
|
|
|
# "Perlized" from C source by Manish Singh <yosh@gimp.org>
|
|
|
|
sub progress_init {
|
|
$blurb = 'Initializes the progress bar for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
Initializes the progress bar for the current plug-in. It is only valid to call
|
|
this procedure from a plug-in.
|
|
HELP
|
|
|
|
&std_pdb_misc;
|
|
|
|
$lib_private = 1;
|
|
|
|
@inargs = (
|
|
{ name => 'message', type => 'string', null_ok => 1,
|
|
desc => 'Message to use in the progress dialog' },
|
|
{ name => 'gdisplay', type => 'display', none_ok => 1,
|
|
desc => 'GimpDisplay to update progressbar in, or %NULL for a separate
|
|
window' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
if (! gimp->no_interface)
|
|
gimp_plug_in_progress_start (plug_in, message, gdisplay);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_update {
|
|
$blurb = 'Updates the progress bar for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
Updates the progress bar for the current plug-in. It is only valid to call this
|
|
procedure from a plug-in.
|
|
HELP
|
|
|
|
&std_pdb_misc;
|
|
|
|
$lib_private = 1;
|
|
|
|
@inargs = (
|
|
{ name => 'percentage', type => 'double',
|
|
desc => 'Percentage of progress completed which must
|
|
be between 0.0 and 1.0' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
if (! gimp->no_interface)
|
|
gimp_plug_in_progress_set_value (plug_in, percentage);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_pulse {
|
|
$blurb = 'Pulses the progress bar for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
Updates the progress bar for the current plug-in. It is only valid to
|
|
call this procedure from a plug-in. Use this function instead of
|
|
gimp_progress_update() if you cannot tell how much progress has been
|
|
made. This usually causes the the progress bar to enter "activity
|
|
mode", where a block bounces back and forth.
|
|
HELP
|
|
|
|
&neo_pdb_misc('2005', '2.4');
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
if (! gimp->no_interface)
|
|
gimp_plug_in_progress_pulse (plug_in);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_set_text {
|
|
$blurb = 'Changes the text in the progress bar for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
This function changes the text in the progress bar for the current
|
|
plug-in. Unlike gimp_progress_init() it does not change the displayed
|
|
value.
|
|
HELP
|
|
|
|
&neo_pdb_misc('2005', '2.4');
|
|
|
|
@inargs = (
|
|
{ name => 'message', type => 'string', null_ok => 1,
|
|
desc => 'Message to use in the progress dialog' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
if (! gimp->no_interface)
|
|
gimp_plug_in_progress_set_text (plug_in, message);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_end {
|
|
$blurb = 'Ends the progress bar for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
Ends the progress display for the current plug-in. Most plug-ins don't need to call this, they just exit when the work is done. It is only valid to call this
|
|
procedure from a plug-in.
|
|
HELP
|
|
|
|
&neo_pdb_misc('2007', '2.4');
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
GimpPlugInProcFrame *proc_frame = gimp_plug_in_get_proc_frame (plug_in);
|
|
|
|
gimp_plug_in_progress_end (plug_in, proc_frame);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_get_window_handle {
|
|
$blurb = 'Returns the native handle of the toplevel window this plug-in\'s progress is or would be displayed in.';
|
|
|
|
$help = <<'HELP';
|
|
This function returns the native handle allowing to identify the toplevel window this plug-in's progress is displayed in.
|
|
It should still work even if the progress bar has not been initialized yet, unless the plug-in wasn't called from a GUI.
|
|
|
|
This handle can be of various types (integer, string, etc.) depending on the platform you are running on which is why it
|
|
returns a GBytes. There are usually no reasons to call this directly.
|
|
HELP
|
|
|
|
&mitch_pdb_misc('2004', '2.2');
|
|
|
|
@outargs = (
|
|
{ name => 'handle', type => 'bytes',
|
|
desc => 'The progress bar\'s toplevel window\'s handle' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
{
|
|
if (! gimp->no_interface)
|
|
handle = gimp_plug_in_progress_get_window_id (plug_in);
|
|
}
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_install {
|
|
$blurb = 'Installs a progress callback for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
This function installs a temporary PDB procedure which will handle all
|
|
progress calls made by this plug-in and any procedure it calls. Calling
|
|
this function multiple times simply replaces the old progress callbacks.
|
|
HELP
|
|
|
|
&mitch_pdb_misc('2004', '2.2');
|
|
|
|
$lib_private = 1;
|
|
|
|
@inargs = (
|
|
{ name => 'progress_callback', type => 'string', non_empty => 1,
|
|
desc => 'The callback PDB proc to call' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
success = gimp_plug_in_progress_install (plug_in, progress_callback);
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_uninstall {
|
|
$blurb = 'Uninstalls the progress callback for the current plug-in.';
|
|
|
|
$help = <<'HELP';
|
|
This function uninstalls any progress callback installed with
|
|
gimp_progress_install() before.
|
|
HELP
|
|
|
|
&mitch_pdb_misc('2004', '2.2');
|
|
|
|
$lib_private = 1;
|
|
|
|
@inargs = (
|
|
{ name => 'progress_callback', type => 'string', non_empty => 1,
|
|
desc => 'The name of the callback registered for this progress' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
success = gimp_plug_in_progress_uninstall (plug_in, progress_callback);
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
sub progress_cancel {
|
|
$blurb = 'Cancels a running progress.';
|
|
|
|
$help = <<'HELP';
|
|
This function cancels the currently running progress.
|
|
HELP
|
|
|
|
&mitch_pdb_misc('2004', '2.2');
|
|
|
|
@inargs = (
|
|
{ name => 'progress_callback', type => 'string', non_empty => 1,
|
|
desc => 'The name of the callback registered for this progress' }
|
|
);
|
|
|
|
%invoke = (
|
|
code => <<'CODE'
|
|
{
|
|
GimpPlugIn *plug_in = gimp->plug_in_manager->current_plug_in;
|
|
|
|
if (plug_in && plug_in->open)
|
|
success = gimp_plug_in_progress_cancel (plug_in, progress_callback);
|
|
else
|
|
success = FALSE;
|
|
}
|
|
CODE
|
|
);
|
|
}
|
|
|
|
|
|
@headers = qw("core/gimp.h"
|
|
"plug-in/gimpplugin.h"
|
|
"plug-in/gimpplugin-progress.h"
|
|
"plug-in/gimppluginmanager.h");
|
|
|
|
@procs = qw(progress_init
|
|
progress_update
|
|
progress_pulse
|
|
progress_set_text
|
|
progress_end
|
|
progress_get_window_handle
|
|
progress_install
|
|
progress_uninstall
|
|
progress_cancel);
|
|
|
|
%exports = (app => [@procs], lib => [@procs]);
|
|
|
|
$desc = 'Progress';
|
|
$doc_title = 'gimpprogress';
|
|
$doc_short_desc = "Functions for embedding the progress bar into a plug-in's GUI.";
|
|
$doc_long_desc = "Functions for embedding the progress bar into a plug-in's GUI.";
|
|
|
|
1;
|