Gimp/app/display/gimpdisplayshell-title.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

604 lines
19 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 <gegl.h>
#include <gtk/gtk.h>
#include "libgimpbase/gimpbase.h"
#include "libgimpcolor/gimpcolor.h"
#include "libgimpwidgets/gimpwidgets.h"
#include "libgimpbase/gimpbase.h"
#include "display-types.h"
#include "config/gimpdisplayconfig.h"
#include "gegl/gimp-babl.h"
#include "core/gimpcontainer.h"
#include "core/gimpdrawable.h"
#include "core/gimpimage.h"
#include "core/gimpimage-color-profile.h"
#include "core/gimpitem.h"
#include "gimpdisplay.h"
#include "gimpdisplayshell.h"
#include "gimpdisplayshell-title.h"
#include "gimpstatusbar.h"
#include "about.h"
#include "gimp-intl.h"
#define MAX_TITLE_BUF 512
static gboolean gimp_display_shell_update_title_idle (gpointer data);
static gint gimp_display_shell_format_title (GimpDisplayShell *display,
gchar *title,
gint title_len,
const gchar *format);
static gint print_unichar (gunichar c,
gchar *title,
gint title_len,
gint index);
/* public functions */
void
gimp_display_shell_title_update (GimpDisplayShell *shell)
{
g_return_if_fail (GIMP_IS_DISPLAY_SHELL (shell));
if (shell->title_idle_id)
g_source_remove (shell->title_idle_id);
shell->title_idle_id = g_idle_add (gimp_display_shell_update_title_idle,
shell);
}
/* private functions */
static gboolean
gimp_display_shell_update_title_idle (gpointer data)
{
GimpDisplayShell *shell = GIMP_DISPLAY_SHELL (data);
shell->title_idle_id = 0;
if (gimp_display_get_image (shell->display))
{
GimpDisplayConfig *config = shell->display->config;
gchar title[MAX_TITLE_BUF];
gchar status[MAX_TITLE_BUF];
gint len;
/* format the title */
len = gimp_display_shell_format_title (shell, title, sizeof (title),
config->image_title_format);
if (len) /* U+2013 EN DASH */
len += g_strlcpy (title + len, " \342\200\223 ", sizeof (title) - len);
g_strlcpy (title + len, GIMP_ACRONYM, sizeof (title) - len);
/* format the statusbar */
gimp_display_shell_format_title (shell, status, sizeof (status),
config->image_status_format);
g_object_set (shell,
"title", title,
"status", status,
NULL);
}
else
{
g_object_set (shell,
"title", GIMP_NAME,
"status", " ",
NULL);
}
return FALSE;
}
static const gchar *
gimp_display_shell_title_image_type (GimpImage *image)
{
const gchar *name = "";
gimp_enum_get_value (GIMP_TYPE_IMAGE_BASE_TYPE,
gimp_image_get_base_type (image), NULL, NULL, &name, NULL);
return name;
}
static const gchar *
gimp_display_shell_title_image_precision (GimpImage *image)
{
const gchar *name = "";
gimp_enum_get_value (GIMP_TYPE_PRECISION,
gimp_image_get_precision (image), NULL, NULL, &name, NULL);
return name;
}
static gint print (gchar *buf,
gint len,
gint start,
const gchar *fmt,
...) G_GNUC_PRINTF (4, 5);
static gint
print (gchar *buf,
gint len,
gint start,
const gchar *fmt,
...)
{
va_list args;
gint printed;
va_start (args, fmt);
printed = g_vsnprintf (buf + start, len - start, fmt, args);
if (printed < 0)
printed = len - start;
va_end (args);
return printed;
}
static gint
print_unichar (gunichar c,
gchar *title,
gint title_len,
gint index)
{
gchar letter[8];
gint len;
len = g_unichar_to_utf8 (c, letter);
letter[len] = '\0';
return print (title, title_len, index, "%s", letter);
}
static gint
gimp_display_shell_format_title (GimpDisplayShell *shell,
gchar *title,
gint title_len,
const gchar *format)
{
GimpImage *image;
GimpDrawable *drawable = NULL;
GList *drawables;
gint num, denom;
gint i = 0;
gunichar c;
g_return_val_if_fail (GIMP_IS_DISPLAY_SHELL (shell), 0);
image = gimp_display_get_image (shell->display);
if (! image)
{
title[0] = '\n';
return 0;
}
/* GIMP window title only take single selected layer into account so
* far (not sure how we could have multi-layer concept there, except
* wanting never-ending window titles!).
* When multiple drawables are selected, we just display nothing.
*/
drawables = gimp_image_get_selected_drawables (image);
if (g_list_length (drawables) == 1)
drawable = drawables->data;
g_list_free (drawables);
gimp_zoom_model_get_fraction (shell->zoom, &num, &denom);
c = g_utf8_get_char (format);
while (i < title_len && c)
{
switch (c)
{
case '%':
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
switch (c)
{
case 0:
/* format string ends within %-sequence, print literal '%' */
case '%':
title[i++] = '%';
break;
case 'f': /* base filename */
i += print (title, title_len, i, "%s",
gimp_image_get_display_name (image));
break;
case 'F': /* full filename */
i += print (title, title_len, i, "%s",
gimp_image_get_display_path (image));
break;
case 'p': /* PDB id */
i += print (title, title_len, i, "%d", gimp_image_get_id (image));
break;
case 'i': /* instance */
i += print (title, title_len, i, "%d",
gimp_display_get_instance (shell->display));
break;
case 't': /* image type */
i += print (title, title_len, i, "%s %s",
gimp_display_shell_title_image_type (image),
gimp_display_shell_title_image_precision (image));
break;
case 'T': /* drawable type */
if (drawable)
{
const Babl *format = gimp_drawable_get_format (drawable);
i += print (title, title_len, i, "%s",
gimp_babl_format_get_description (format));
}
break;
case 's': /* user source zoom factor */
i += print (title, title_len, i, "%d", denom);
break;
case 'd': /* user destination zoom factor */
i += print (title, title_len, i, "%d", num);
break;
case 'z': /* user zoom factor (percentage) */
{
gdouble scale = gimp_zoom_model_get_factor (shell->zoom);
i += print (title, title_len, i,
scale >= 0.15 ? "%.0f" : "%.2f", 100.0 * scale);
}
break;
case 'D': /* dirty flag */
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
if (c == 0)
{
/* format string ends within %D-sequence, print literal '%D' */
i += print (title, title_len, i, "%%D");
break;
}
if (gimp_image_is_dirty (image))
i += print_unichar (c, title, title_len, i);
break;
case 'C': /* clean flag */
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
if (c == 0)
{
/* format string ends within %C-sequence, print literal '%C' */
i += print (title, title_len, i, "%%C");
break;
}
if (! gimp_image_is_dirty (image))
i += print_unichar (c, title, title_len, i);
break;
case 'B': /* dirty flag (long) */
if (gimp_image_is_dirty (image))
i += print (title, title_len, i, "%s", _("(modified)"));
break;
case 'A': /* clean flag (long) */
if (! gimp_image_is_dirty (image))
i += print (title, title_len, i, "%s", _("(clean)"));
break;
case 'N': /* not-exported flag */
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
if (c == 0)
{
/* format string ends within %E-sequence, print literal '%E' */
i += print (title, title_len, i, "%%N");
break;
}
if (gimp_image_is_export_dirty (image))
i += print_unichar (c, title, title_len, i);
break;
case 'E': /* exported flag */
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
if (c == 0)
{
/* format string ends within %E-sequence, print literal '%E' */
i += print (title, title_len, i, "%%E");
break;
}
if (! gimp_image_is_export_dirty (image))
i += print_unichar (c, title, title_len, i);
break;
case 'm': /* memory used by image */
{
GimpObject *object = GIMP_OBJECT (image);
gchar *str;
str = g_format_size (gimp_object_get_memsize (object, NULL));
i += print (title, title_len, i, "%s", str);
g_free (str);
}
break;
case 'M': /* image size in megapixels */
i += print (title, title_len, i, "%.1f",
(gdouble) gimp_image_get_width (image) *
(gdouble) gimp_image_get_height (image) / 1000000.0);
break;
case 'l': /* number of layers */
i += print (title, title_len, i, "%d",
gimp_image_get_n_layers (image));
break;
case 'L': /* number of layers (long) */
{
gint num = gimp_image_get_n_layers (image);
i += print (title, title_len, i,
ngettext ("%d layer", "%d layers", num), num);
}
break;
case 'n': /* active drawable name */
if (drawable)
{
gchar *desc;
desc = gimp_viewable_get_description (GIMP_VIEWABLE (drawable),
NULL);
i += print (title, title_len, i, "%s", desc);
g_free (desc);
}
else
{
i += print (title, title_len, i, "%s", _("(none)"));
}
break;
case 'P': /* active drawable PDB id */
if (drawable)
i += print (title, title_len, i, "%d",
gimp_item_get_id (GIMP_ITEM (drawable)));
else
i += print (title, title_len, i, "%s", _("(none)"));
break;
case 'W': /* width in real-world units */
if (shell->unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gchar unit_format[8];
gimp_image_get_resolution (image, &xres, &yres);
g_snprintf (unit_format, sizeof (unit_format), "%%.%df",
gimp_unit_get_scaled_digits (shell->unit, xres));
i += print (title, title_len, i, unit_format,
gimp_pixels_to_units (gimp_image_get_width (image),
shell->unit, xres));
break;
}
/* else fallthru */
case 'w': /* width in pixels */
i += print (title, title_len, i, "%d",
gimp_image_get_width (image));
break;
case 'H': /* height in real-world units */
if (shell->unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gchar unit_format[8];
gimp_image_get_resolution (image, &xres, &yres);
g_snprintf (unit_format, sizeof (unit_format), "%%.%df",
gimp_unit_get_scaled_digits (shell->unit, yres));
i += print (title, title_len, i, unit_format,
gimp_pixels_to_units (gimp_image_get_height (image),
shell->unit, yres));
break;
}
/* else fallthru */
case 'h': /* height in pixels */
i += print (title, title_len, i, "%d",
gimp_image_get_height (image));
break;
case 'u': /* unit symbol */
i += print (title, title_len, i, "%s",
gimp_unit_get_symbol (shell->unit));
break;
case 'U': /* unit abbreviation */
i += print (title, title_len, i, "%s",
gimp_unit_get_abbreviation (shell->unit));
break;
case 'X': /* drawable width in real world units */
if (drawable && shell->unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gchar unit_format[8];
gimp_image_get_resolution (image, &xres, &yres);
g_snprintf (unit_format, sizeof (unit_format), "%%.%df",
gimp_unit_get_scaled_digits (shell->unit, xres));
i += print (title, title_len, i, unit_format,
gimp_pixels_to_units (gimp_item_get_width
(GIMP_ITEM (drawable)),
shell->unit, xres));
break;
}
/* else fallthru */
case 'x': /* drawable width in pixels */
if (drawable)
i += print (title, title_len, i, "%d",
gimp_item_get_width (GIMP_ITEM (drawable)));
break;
case 'Y': /* drawable height in real world units */
if (drawable && shell->unit != gimp_unit_pixel ())
{
gdouble xres;
gdouble yres;
gchar unit_format[8];
gimp_image_get_resolution (image, &xres, &yres);
g_snprintf (unit_format, sizeof (unit_format), "%%.%df",
gimp_unit_get_scaled_digits (shell->unit, yres));
i += print (title, title_len, i, unit_format,
gimp_pixels_to_units (gimp_item_get_height
(GIMP_ITEM (drawable)),
shell->unit, yres));
break;
}
/* else fallthru */
case 'y': /* drawable height in pixels */
if (drawable)
i += print (title, title_len, i, "%d",
gimp_item_get_height (GIMP_ITEM (drawable)));
break;
case 'o': /* image's color profile name */
{
GimpColorManaged *managed = GIMP_COLOR_MANAGED (image);
GimpColorProfile *profile;
profile = gimp_color_managed_get_color_profile (managed);
i += print (title, title_len, i, "%s",
gimp_color_profile_get_label (profile));
}
break;
case 'e': /* display's offsets in pixels */
{
gdouble scale = gimp_zoom_model_get_factor (shell->zoom);
gdouble offset_x = shell->offset_x / scale;
gdouble offset_y = shell->offset_y / scale;
i += print (title, title_len, i,
scale >= 0.15 ? "%.0fx%.0f" : "%.2fx%.2f",
offset_x, offset_y);
}
break;
case 'r': /* view rotation angle in degrees */
{
i += print (title, title_len, i, "%.1f", shell->rotate_angle);
}
break;
case '\xc3': /* utf-8 extended char */
{
format ++;
switch (*format)
{
case '\xbe':
/* line actually written at 23:55 on an Easter Sunday */
i += print (title, title_len, i, "42");
break;
default:
/* in the case of an unhandled utf-8 extended char format
* leave the format string parsing as it was
*/
format--;
break;
}
}
break;
/* Other cool things to be added:
* %r = xresolution
* %R = yresolution
* %ø = image's fractal dimension
* %þ = the answer to everything - (implemented)
*/
default:
/* format string contains unknown %-sequence, print it literally */
i += print_unichar (c, title, title_len, i);
break;
}
break;
default:
i += print_unichar (c, title, title_len, i);
break;
}
format = g_utf8_next_char (format);
c = g_utf8_get_char (format);
}
title[MIN (i, title_len - 1)] = '\0';
return i;
}