Gimp/app/core/gimpimageundo.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

532 lines
18 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 <string.h>
#include <cairo.h>
#include <gegl.h>
#include <gdk-pixbuf/gdk-pixbuf.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpcolor/gimpcolor.h"
#include "libgimpconfig/gimpconfig.h"
#include "core-types.h"
#include "gimp-memsize.h"
#include "gimpdrawable.h"
#include "gimpgrid.h"
#include "gimpimage.h"
#include "gimpimage-color-profile.h"
#include "gimpimage-colormap.h"
#include "gimpimage-grid.h"
#include "gimpimage-metadata.h"
#include "gimpimage-private.h"
#include "gimpimageundo.h"
enum
{
PROP_0,
PROP_PREVIOUS_ORIGIN_X,
PROP_PREVIOUS_ORIGIN_Y,
PROP_PREVIOUS_WIDTH,
PROP_PREVIOUS_HEIGHT,
PROP_GRID,
PROP_PARASITE_NAME
};
static void gimp_image_undo_constructed (GObject *object);
static void gimp_image_undo_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec);
static void gimp_image_undo_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec);
static gint64 gimp_image_undo_get_memsize (GimpObject *object,
gint64 *gui_size);
static void gimp_image_undo_pop (GimpUndo *undo,
GimpUndoMode undo_mode,
GimpUndoAccumulator *accum);
static void gimp_image_undo_free (GimpUndo *undo,
GimpUndoMode undo_mode);
G_DEFINE_TYPE (GimpImageUndo, gimp_image_undo, GIMP_TYPE_UNDO)
#define parent_class gimp_image_undo_parent_class
static void
gimp_image_undo_class_init (GimpImageUndoClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
GimpObjectClass *gimp_object_class = GIMP_OBJECT_CLASS (klass);
GimpUndoClass *undo_class = GIMP_UNDO_CLASS (klass);
object_class->constructed = gimp_image_undo_constructed;
object_class->set_property = gimp_image_undo_set_property;
object_class->get_property = gimp_image_undo_get_property;
gimp_object_class->get_memsize = gimp_image_undo_get_memsize;
undo_class->pop = gimp_image_undo_pop;
undo_class->free = gimp_image_undo_free;
g_object_class_install_property (object_class, PROP_PREVIOUS_ORIGIN_X,
g_param_spec_int ("previous-origin-x",
NULL, NULL,
-GIMP_MAX_IMAGE_SIZE,
GIMP_MAX_IMAGE_SIZE,
0,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_PREVIOUS_ORIGIN_Y,
g_param_spec_int ("previous-origin-y",
NULL, NULL,
-GIMP_MAX_IMAGE_SIZE,
GIMP_MAX_IMAGE_SIZE,
0,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_PREVIOUS_WIDTH,
g_param_spec_int ("previous-width",
NULL, NULL,
-GIMP_MAX_IMAGE_SIZE,
GIMP_MAX_IMAGE_SIZE,
0,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_PREVIOUS_HEIGHT,
g_param_spec_int ("previous-height",
NULL, NULL,
-GIMP_MAX_IMAGE_SIZE,
GIMP_MAX_IMAGE_SIZE,
0,
GIMP_PARAM_READWRITE));
g_object_class_install_property (object_class, PROP_GRID,
g_param_spec_object ("grid", NULL, NULL,
GIMP_TYPE_GRID,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
g_object_class_install_property (object_class, PROP_PARASITE_NAME,
g_param_spec_string ("parasite-name",
NULL, NULL,
NULL,
GIMP_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
}
static void
gimp_image_undo_init (GimpImageUndo *undo)
{
}
static void
gimp_image_undo_constructed (GObject *object)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (object);
GimpImage *image;
G_OBJECT_CLASS (parent_class)->constructed (object);
image = GIMP_UNDO (object)->image;
switch (GIMP_UNDO (object)->undo_type)
{
case GIMP_UNDO_IMAGE_TYPE:
image_undo->base_type = gimp_image_get_base_type (image);
break;
case GIMP_UNDO_IMAGE_PRECISION:
image_undo->precision = gimp_image_get_precision (image);
break;
case GIMP_UNDO_IMAGE_SIZE:
image_undo->width = gimp_image_get_width (image);
image_undo->height = gimp_image_get_height (image);
break;
case GIMP_UNDO_IMAGE_RESOLUTION:
gimp_image_get_resolution (image,
&image_undo->xresolution,
&image_undo->yresolution);
image_undo->resolution_unit = gimp_image_get_unit (image);
break;
case GIMP_UNDO_IMAGE_GRID:
gimp_assert (GIMP_IS_GRID (image_undo->grid));
break;
case GIMP_UNDO_IMAGE_COLORMAP:
image_undo->colormap = _gimp_image_get_colormap (image, &image_undo->num_colors);
break;
case GIMP_UNDO_IMAGE_HIDDEN_PROFILE:
g_set_object (&image_undo->hidden_profile,
_gimp_image_get_hidden_profile (image));
break;
case GIMP_UNDO_IMAGE_METADATA:
image_undo->metadata =
gimp_metadata_duplicate (gimp_image_get_metadata (image));
break;
case GIMP_UNDO_PARASITE_ATTACH:
case GIMP_UNDO_PARASITE_REMOVE:
gimp_assert (image_undo->parasite_name != NULL);
image_undo->parasite = gimp_parasite_copy
(gimp_image_parasite_find (image, image_undo->parasite_name));
break;
default:
g_return_if_reached ();
}
}
static void
gimp_image_undo_set_property (GObject *object,
guint property_id,
const GValue *value,
GParamSpec *pspec)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (object);
switch (property_id)
{
case PROP_PREVIOUS_ORIGIN_X:
image_undo->previous_origin_x = g_value_get_int (value);
break;
case PROP_PREVIOUS_ORIGIN_Y:
image_undo->previous_origin_y = g_value_get_int (value);
break;
case PROP_PREVIOUS_WIDTH:
image_undo->previous_width = g_value_get_int (value);
break;
case PROP_PREVIOUS_HEIGHT:
image_undo->previous_height = g_value_get_int (value);
break;
case PROP_GRID:
{
GimpGrid *grid = g_value_get_object (value);
if (grid)
image_undo->grid = gimp_config_duplicate (GIMP_CONFIG (grid));
}
break;
case PROP_PARASITE_NAME:
image_undo->parasite_name = g_value_dup_string (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static void
gimp_image_undo_get_property (GObject *object,
guint property_id,
GValue *value,
GParamSpec *pspec)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (object);
switch (property_id)
{
case PROP_PREVIOUS_ORIGIN_X:
g_value_set_int (value, image_undo->previous_origin_x);
break;
case PROP_PREVIOUS_ORIGIN_Y:
g_value_set_int (value, image_undo->previous_origin_y);
break;
case PROP_PREVIOUS_WIDTH:
g_value_set_int (value, image_undo->previous_width);
break;
case PROP_PREVIOUS_HEIGHT:
g_value_set_int (value, image_undo->previous_height);
break;
case PROP_GRID:
g_value_set_object (value, image_undo->grid);
break;
case PROP_PARASITE_NAME:
g_value_set_string (value, image_undo->parasite_name);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
break;
}
}
static gint64
gimp_image_undo_get_memsize (GimpObject *object,
gint64 *gui_size)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (object);
gint64 memsize = 0;
if (image_undo->colormap)
memsize += GIMP_IMAGE_COLORMAP_SIZE;
if (image_undo->metadata)
memsize += gimp_g_object_get_memsize (G_OBJECT (image_undo->metadata));
memsize += gimp_object_get_memsize (GIMP_OBJECT (image_undo->grid),
gui_size);
memsize += gimp_string_get_memsize (image_undo->parasite_name);
memsize += gimp_parasite_get_memsize (image_undo->parasite, gui_size);
return memsize + GIMP_OBJECT_CLASS (parent_class)->get_memsize (object,
gui_size);
}
static void
gimp_image_undo_pop (GimpUndo *undo,
GimpUndoMode undo_mode,
GimpUndoAccumulator *accum)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (undo);
GimpImage *image = undo->image;
GimpImagePrivate *private = GIMP_IMAGE_GET_PRIVATE (image);
GIMP_UNDO_CLASS (parent_class)->pop (undo, undo_mode, accum);
switch (undo->undo_type)
{
case GIMP_UNDO_IMAGE_TYPE:
{
GimpImageBaseType base_type;
base_type = image_undo->base_type;
image_undo->base_type = gimp_image_get_base_type (image);
g_object_set (image, "base-type", base_type, NULL);
gimp_image_colormap_changed (image, -1);
if (image_undo->base_type != gimp_image_get_base_type (image))
{
if ((image_undo->base_type == GIMP_GRAY) ||
(gimp_image_get_base_type (image) == GIMP_GRAY))
{
/* in case there was no profile undo, we need to emit
* profile-changed anyway
*/
gimp_color_managed_profile_changed (GIMP_COLOR_MANAGED (image));
}
accum->mode_changed = TRUE;
}
}
break;
case GIMP_UNDO_IMAGE_PRECISION:
{
GimpPrecision precision;
precision = image_undo->precision;
image_undo->precision = gimp_image_get_precision (image);
g_object_set (image, "precision", precision, NULL);
if (image_undo->precision != gimp_image_get_precision (image))
accum->precision_changed = TRUE;
}
break;
case GIMP_UNDO_IMAGE_SIZE:
{
gint width;
gint height;
gint previous_origin_x;
gint previous_origin_y;
gint previous_width;
gint previous_height;
width = image_undo->width;
height = image_undo->height;
previous_origin_x = image_undo->previous_origin_x;
previous_origin_y = image_undo->previous_origin_y;
previous_width = image_undo->previous_width;
previous_height = image_undo->previous_height;
/* Transform to a redo */
image_undo->width = gimp_image_get_width (image);
image_undo->height = gimp_image_get_height (image);
image_undo->previous_origin_x = -previous_origin_x;
image_undo->previous_origin_y = -previous_origin_y;
image_undo->previous_width = width;
image_undo->previous_height = height;
g_object_set (image,
"width", width,
"height", height,
NULL);
gimp_drawable_invalidate_boundary
(GIMP_DRAWABLE (gimp_image_get_mask (image)));
if (gimp_image_get_width (image) != image_undo->width ||
gimp_image_get_height (image) != image_undo->height)
{
accum->size_changed = TRUE;
accum->previous_origin_x = previous_origin_x;
accum->previous_origin_y = previous_origin_y;
accum->previous_width = previous_width;
accum->previous_height = previous_height;
}
}
break;
case GIMP_UNDO_IMAGE_RESOLUTION:
{
gdouble xres;
gdouble yres;
gimp_image_get_resolution (image, &xres, &yres);
if (ABS (image_undo->xresolution - xres) >= 1e-5 ||
ABS (image_undo->yresolution - yres) >= 1e-5)
{
private->xresolution = image_undo->xresolution;
private->yresolution = image_undo->yresolution;
image_undo->xresolution = xres;
image_undo->yresolution = yres;
accum->resolution_changed = TRUE;
}
}
if (image_undo->resolution_unit != gimp_image_get_unit (image))
{
GimpUnit *unit;
unit = gimp_image_get_unit (image);
private->resolution_unit = image_undo->resolution_unit;
image_undo->resolution_unit = unit;
accum->unit_changed = TRUE;
}
break;
case GIMP_UNDO_IMAGE_GRID:
{
GimpGrid *grid;
grid = gimp_config_duplicate (GIMP_CONFIG (gimp_image_get_grid (image)));
gimp_image_set_grid (image, image_undo->grid, FALSE);
g_object_unref (image_undo->grid);
image_undo->grid = grid;
}
break;
case GIMP_UNDO_IMAGE_COLORMAP:
{
guchar *colormap;
gint num_colors;
colormap = _gimp_image_get_colormap (image, &num_colors);
if (image_undo->colormap)
_gimp_image_set_colormap (image, image_undo->colormap,
image_undo->num_colors, FALSE);
else
gimp_image_unset_colormap (image, FALSE);
if (image_undo->colormap)
g_free (image_undo->colormap);
image_undo->num_colors = num_colors;
image_undo->colormap = colormap;
}
break;
case GIMP_UNDO_IMAGE_HIDDEN_PROFILE:
{
GimpColorProfile *hidden_profile = NULL;
g_set_object (&hidden_profile, _gimp_image_get_hidden_profile (image));
_gimp_image_set_hidden_profile (image, image_undo->hidden_profile,
FALSE);
image_undo->hidden_profile = hidden_profile;
}
break;
case GIMP_UNDO_IMAGE_METADATA:
{
GimpMetadata *metadata;
metadata = gimp_metadata_duplicate (gimp_image_get_metadata (image));
gimp_image_set_metadata (image, image_undo->metadata, FALSE);
if (image_undo->metadata)
g_object_unref (image_undo->metadata);
image_undo->metadata = metadata;
}
break;
case GIMP_UNDO_PARASITE_ATTACH:
case GIMP_UNDO_PARASITE_REMOVE:
{
GimpParasite *parasite = image_undo->parasite;
image_undo->parasite = gimp_parasite_copy
(gimp_image_parasite_find (image, image_undo->parasite_name));
if (parasite)
gimp_image_parasite_attach (image, parasite, FALSE);
else
gimp_image_parasite_detach (image, image_undo->parasite_name, FALSE);
if (parasite)
gimp_parasite_free (parasite);
}
break;
default:
g_return_if_reached ();
}
}
static void
gimp_image_undo_free (GimpUndo *undo,
GimpUndoMode undo_mode)
{
GimpImageUndo *image_undo = GIMP_IMAGE_UNDO (undo);
g_clear_object (&image_undo->grid);
g_clear_pointer (&image_undo->colormap, g_free);
g_clear_object (&image_undo->hidden_profile);
g_clear_object (&image_undo->metadata);
g_clear_pointer (&image_undo->parasite_name, g_free);
g_clear_pointer (&image_undo->parasite, gimp_parasite_free);
GIMP_UNDO_CLASS (parent_class)->free (undo, undo_mode);
}