Gimp/app/actions/select-commands.c
Jehan d493f0537f Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!

Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.

As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.

Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.

Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-08-02 10:46:38 +02:00

716 lines
23 KiB
C

/* 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/>.
*/
#include "config.h"
#include <gegl.h>
#include <gtk/gtk.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpmath/gimpmath.h"
#include "libgimpwidgets/gimpwidgets.h"
#include "actions-types.h"
#include "config/gimpdialogconfig.h"
#include "core/gimp.h"
#include "core/gimpchannel.h"
#include "core/gimpimage.h"
#include "core/gimpselection.h"
#include "widgets/gimphelp-ids.h"
#include "widgets/gimpdialogfactory.h"
#include "widgets/gimpwidgets-utils.h"
#include "widgets/gimpwindowstrategy.h"
#include "display/gimpdisplay.h"
#include "display/gimpdisplayshell.h"
#include "dialogs/dialogs.h"
#include "actions.h"
#include "items-commands.h"
#include "select-commands.h"
#include "gimp-intl.h"
/* local function prototypes */
static void select_feather_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data);
static void select_border_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data);
static void select_grow_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data);
static void select_shrink_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data);
static void select_float (GimpAction *action,
GVariant *value,
gboolean cut,
gpointer data);
/* public functions */
void
select_all_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
return_if_no_image (image, data);
gimp_channel_all (gimp_image_get_mask (image), TRUE);
gimp_image_flush (image);
}
void
select_none_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
return_if_no_image (image, data);
gimp_channel_clear (gimp_image_get_mask (image), NULL, TRUE);
gimp_image_flush (image);
}
void
select_invert_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
return_if_no_image (image, data);
gimp_channel_invert (gimp_image_get_mask (image), TRUE);
gimp_image_flush (image);
}
void
select_cut_float_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
select_float (action, value, TRUE, data);
}
void
select_copy_float_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
select_float (action, value, FALSE, data);
}
void
select_feather_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpDisplay *display;
GimpImage *image;
GtkWidget *dialog;
return_if_no_display (display, data);
image = gimp_display_get_image (display);
#define FEATHER_DIALOG_KEY "gimp-selection-feather-dialog"
dialog = dialogs_get_dialog (G_OBJECT (image), FEATHER_DIALOG_KEY);
if (! dialog)
{
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *button;
gdouble xres;
gdouble yres;
gimp_image_get_resolution (image, &xres, &yres);
dialog = gimp_query_size_box (_("Feather Selection"),
GTK_WIDGET (gimp_display_get_shell (display)),
gimp_standard_help_func,
GIMP_HELP_SELECTION_FEATHER,
_("Feather selection by"),
config->selection_feather_radius, 0, 32767, 3,
gimp_display_get_shell (display)->unit,
MIN (xres, yres),
FALSE,
G_OBJECT (image), "disconnect",
select_feather_callback,
image, NULL);
/* Edge lock button */
button = gtk_check_button_new_with_mnemonic (_("_Selected areas continue outside the image"));
g_object_set_data (G_OBJECT (dialog), "edge-lock-toggle", button);
gimp_help_set_help_data (button,
_("When feathering, act as if selected areas "
"continued outside the image."),
NULL);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button),
config->selection_feather_edge_lock);
gtk_box_pack_start (GTK_BOX (GIMP_QUERY_BOX_VBOX (dialog)), button,
FALSE, FALSE, 0);
gtk_widget_show (button);
dialogs_attach_dialog (G_OBJECT (image), FEATHER_DIALOG_KEY, dialog);
}
gtk_window_present (GTK_WINDOW (dialog));
}
void
select_sharpen_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
return_if_no_image (image, data);
gimp_channel_sharpen (gimp_image_get_mask (image), TRUE);
gimp_image_flush (image);
}
void
select_shrink_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpDisplay *display;
GimpImage *image;
GtkWidget *dialog;
return_if_no_display (display, data);
image = gimp_display_get_image (display);
#define SHRINK_DIALOG_KEY "gimp-selection-shrink-dialog"
dialog = dialogs_get_dialog (G_OBJECT (image), SHRINK_DIALOG_KEY);
if (! dialog)
{
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *button;
gint width;
gint height;
gint max_value;
gdouble xres;
gdouble yres;
gimp_item_bounds (GIMP_ITEM (gimp_image_get_mask (image)),
NULL, NULL, &width, &height);
max_value = MIN (width, height) / 2;
gimp_image_get_resolution (image, &xres, &yres);
dialog = gimp_query_size_box (_("Shrink Selection"),
GTK_WIDGET (gimp_display_get_shell (display)),
gimp_standard_help_func,
GIMP_HELP_SELECTION_SHRINK,
_("Shrink selection by"),
config->selection_shrink_radius,
1, max_value, 0,
gimp_display_get_shell (display)->unit,
MIN (xres, yres),
FALSE,
G_OBJECT (image), "disconnect",
select_shrink_callback,
image, NULL);
/* Edge lock button */
button = gtk_check_button_new_with_mnemonic (_("_Selected areas continue outside the image"));
g_object_set_data (G_OBJECT (dialog), "edge-lock-toggle", button);
gimp_help_set_help_data (button,
_("When shrinking, act as if selected areas "
"continued outside the image."),
NULL);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button),
config->selection_shrink_edge_lock);
gtk_box_pack_start (GTK_BOX (GIMP_QUERY_BOX_VBOX (dialog)), button,
FALSE, FALSE, 0);
gtk_widget_show (button);
dialogs_attach_dialog (G_OBJECT (image), SHRINK_DIALOG_KEY, dialog);
}
gtk_window_present (GTK_WINDOW (dialog));
}
void
select_grow_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpDisplay *display;
GimpImage *image;
GtkWidget *dialog;
return_if_no_display (display, data);
image = gimp_display_get_image (display);
#define GROW_DIALOG_KEY "gimp-selection-grow-dialog"
dialog = dialogs_get_dialog (G_OBJECT (image), GROW_DIALOG_KEY);
if (! dialog)
{
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
gint width;
gint height;
gint max_value;
gdouble xres;
gdouble yres;
width = gimp_image_get_width (image);
height = gimp_image_get_height (image);
max_value = MAX (width, height);
gimp_image_get_resolution (image, &xres, &yres);
dialog = gimp_query_size_box (_("Grow Selection"),
GTK_WIDGET (gimp_display_get_shell (display)),
gimp_standard_help_func,
GIMP_HELP_SELECTION_GROW,
_("Grow selection by"),
config->selection_grow_radius,
1, max_value, 0,
gimp_display_get_shell (display)->unit,
MIN (xres, yres),
FALSE,
G_OBJECT (image), "disconnect",
select_grow_callback,
image, NULL);
dialogs_attach_dialog (G_OBJECT (image), GROW_DIALOG_KEY, dialog);
}
gtk_window_present (GTK_WINDOW (dialog));
}
void
select_border_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpDisplay *display;
GimpImage *image;
GtkWidget *dialog;
return_if_no_display (display, data);
image = gimp_display_get_image (display);
#define BORDER_DIALOG_KEY "gimp-selection-border-dialog"
dialog = dialogs_get_dialog (G_OBJECT (image), BORDER_DIALOG_KEY);
if (! dialog)
{
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *combo;
GtkWidget *button;
gint width;
gint height;
gint max_value;
gdouble xres;
gdouble yres;
gimp_item_bounds (GIMP_ITEM (gimp_image_get_mask (image)),
NULL, NULL, &width, &height);
max_value = MIN (width, height) / 2;
gimp_image_get_resolution (image, &xres, &yres);
dialog = gimp_query_size_box (_("Border Selection"),
GTK_WIDGET (gimp_display_get_shell (display)),
gimp_standard_help_func,
GIMP_HELP_SELECTION_BORDER,
_("Border selection by"),
config->selection_border_radius,
1, max_value, 0,
gimp_display_get_shell (display)->unit,
MIN (xres, yres),
FALSE,
G_OBJECT (image), "disconnect",
select_border_callback,
image, NULL);
/* Border style combo */
combo = gimp_enum_combo_box_new (GIMP_TYPE_CHANNEL_BORDER_STYLE);
gimp_int_combo_box_set_label (GIMP_INT_COMBO_BOX (combo),
_("Border style"));
gtk_box_pack_start (GTK_BOX (GIMP_QUERY_BOX_VBOX (dialog)), combo,
FALSE, FALSE, 0);
g_object_set_data (G_OBJECT (dialog), "border-style-combo", combo);
gimp_int_combo_box_set_active (GIMP_INT_COMBO_BOX (combo),
config->selection_border_style);
gtk_widget_show (combo);
/* Edge lock button */
button = gtk_check_button_new_with_mnemonic (_("_Selected areas continue outside the image"));
g_object_set_data (G_OBJECT (dialog), "edge-lock-toggle", button);
gimp_help_set_help_data (button,
_("When bordering, act as if selected areas "
"continued outside the image."),
NULL);
gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button),
config->selection_border_edge_lock);
gtk_box_pack_start (GTK_BOX (GIMP_QUERY_BOX_VBOX (dialog)), button,
FALSE, FALSE, 0);
gtk_widget_show (button);
dialogs_attach_dialog (G_OBJECT (image), BORDER_DIALOG_KEY, dialog);
}
gtk_window_present (GTK_WINDOW (dialog));
}
void
select_flood_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
return_if_no_image (image, data);
gimp_channel_flood (gimp_image_get_mask (image), TRUE);
gimp_image_flush (image);
}
void
select_save_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
GimpChannel *channel;
GtkWidget *widget;
return_if_no_image (image, data);
return_if_no_widget (widget, data);
channel = GIMP_CHANNEL (gimp_item_duplicate (GIMP_ITEM (gimp_image_get_mask (image)),
GIMP_TYPE_CHANNEL));
/* saved selections are not visible by default */
gimp_item_set_visible (GIMP_ITEM (channel), FALSE, FALSE);
gimp_image_add_channel (image, channel,
GIMP_IMAGE_ACTIVE_PARENT, -1, TRUE);
gimp_image_flush (image);
gimp_window_strategy_show_dockable_dialog (GIMP_WINDOW_STRATEGY (gimp_get_window_strategy (image->gimp)),
image->gimp,
gimp_dialog_factory_get_singleton (),
gimp_widget_get_monitor (widget),
"gimp-channel-list");
}
void
select_fill_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
GList *selection;
return_if_no_image (image, data);
selection = g_list_prepend (NULL, gimp_image_get_mask (image)),
items_fill_cmd_callback (action,
image, selection,
_("Fill Selection Outline"),
GIMP_ICON_TOOL_BUCKET_FILL,
GIMP_HELP_SELECTION_FILL,
data);
g_list_free (selection);
}
void
select_fill_last_vals_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
GList *selection;
return_if_no_image (image, data);
selection = g_list_prepend (NULL, gimp_image_get_mask (image)),
items_fill_last_vals_cmd_callback (action, image, selection, data);
g_list_free (selection);
}
void
select_stroke_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
GList *selection;
return_if_no_image (image, data);
selection = g_list_prepend (NULL, gimp_image_get_mask (image)),
items_stroke_cmd_callback (action, image, selection,
_("Stroke Selection"),
GIMP_ICON_SELECTION_STROKE,
GIMP_HELP_SELECTION_STROKE,
data);
g_list_free (selection);
}
void
select_stroke_last_vals_cmd_callback (GimpAction *action,
GVariant *value,
gpointer data)
{
GimpImage *image;
GList *selection;
return_if_no_image (image, data);
selection = g_list_prepend (NULL, gimp_image_get_mask (image)),
items_stroke_last_vals_cmd_callback (action, image, selection, data);
g_list_free (selection);
}
/* private functions */
static void
select_feather_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data)
{
GimpImage *image = GIMP_IMAGE (data);
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *button;
gdouble radius_x;
gdouble radius_y;
button = g_object_get_data (G_OBJECT (widget), "edge-lock-toggle");
g_object_set (config,
"selection-feather-radius", size,
"selection-feather-edge-lock",
gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)),
NULL);
radius_x = config->selection_feather_radius;
radius_y = config->selection_feather_radius;
if (unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gdouble factor;
gimp_image_get_resolution (image, &xres, &yres);
factor = (MAX (xres, yres) /
MIN (xres, yres));
if (xres == MIN (xres, yres))
radius_y *= factor;
else
radius_x *= factor;
}
gimp_channel_feather (gimp_image_get_mask (image), radius_x, radius_y,
config->selection_feather_edge_lock,
TRUE);
gimp_image_flush (image);
}
static void
select_border_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data)
{
GimpImage *image = GIMP_IMAGE (data);
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *combo;
GtkWidget *button;
gdouble radius_x;
gdouble radius_y;
gint border_style;
combo = g_object_get_data (G_OBJECT (widget), "border-style-combo");
button = g_object_get_data (G_OBJECT (widget), "edge-lock-toggle");
gimp_int_combo_box_get_active (GIMP_INT_COMBO_BOX (combo), &border_style);
g_object_set (config,
"selection-border-radius", size,
"selection-border-style", border_style,
"selection-border-edge-lock",
gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)),
NULL);
radius_x = ROUND (config->selection_border_radius);
radius_y = ROUND (config->selection_border_radius);
if (unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gdouble factor;
gimp_image_get_resolution (image, &xres, &yres);
factor = (MAX (xres, yres) /
MIN (xres, yres));
if (xres == MIN (xres, yres))
radius_y *= factor;
else
radius_x *= factor;
}
gimp_channel_border (gimp_image_get_mask (image), radius_x, radius_y,
config->selection_border_style,
config->selection_border_edge_lock,
TRUE);
gimp_image_flush (image);
}
static void
select_grow_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data)
{
GimpImage *image = GIMP_IMAGE (data);
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
gdouble radius_x;
gdouble radius_y;
g_object_set (config,
"selection-grow-radius", size,
NULL);
radius_x = ROUND (config->selection_grow_radius);
radius_y = ROUND (config->selection_grow_radius);
if (unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gdouble factor;
gimp_image_get_resolution (image, &xres, &yres);
factor = (MAX (xres, yres) /
MIN (xres, yres));
if (xres == MIN (xres, yres))
radius_y *= factor;
else
radius_x *= factor;
}
gimp_channel_grow (gimp_image_get_mask (image), radius_x, radius_y, TRUE);
gimp_image_flush (image);
}
static void
select_shrink_callback (GtkWidget *widget,
gdouble size,
GimpUnit *unit,
gpointer data)
{
GimpImage *image = GIMP_IMAGE (data);
GimpDialogConfig *config = GIMP_DIALOG_CONFIG (image->gimp->config);
GtkWidget *button;
gint radius_x;
gint radius_y;
button = g_object_get_data (G_OBJECT (widget), "edge-lock-toggle");
g_object_set (config,
"selection-shrink-radius", size,
"selection-shrink-edge-lock",
gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (button)),
NULL);
radius_x = ROUND (config->selection_shrink_radius);
radius_y = ROUND (config->selection_shrink_radius);
if (unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gdouble factor;
gimp_image_get_resolution (image, &xres, &yres);
factor = (MAX (xres, yres) /
MIN (xres, yres));
if (xres == MIN (xres, yres))
radius_y *= factor;
else
radius_x *= factor;
}
gimp_channel_shrink (gimp_image_get_mask (image), radius_x, radius_y,
config->selection_shrink_edge_lock,
TRUE);
gimp_image_flush (image);
}
static void
select_float (GimpAction *action,
GVariant *value,
gboolean cut,
gpointer data)
{
GimpImage *image;
GtkWidget *widget;
GList *drawables;
GError *error = NULL;
return_if_no_image (image, data);
return_if_no_widget (widget, data);
drawables = gimp_image_get_selected_drawables (image);
if (gimp_selection_float (GIMP_SELECTION (gimp_image_get_mask (image)),
drawables,
action_data_get_context (data),
cut, 0, 0, &error))
{
gimp_image_flush (image);
}
else
{
gimp_message_literal (image->gimp,
G_OBJECT (widget), GIMP_MESSAGE_WARNING,
error->message);
g_clear_error (&error);
}
g_list_free (drawables);
}