mirror of
https://gitlab.gnome.org/GNOME/gimp.git
synced 2025-07-04 01:43:24 +00:00

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.
109 lines
3.5 KiB
C
109 lines
3.5 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
|
*
|
|
* 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 3 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, see
|
|
* <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __GIMP_BASE_TYPES_H__
|
|
#define __GIMP_BASE_TYPES_H__
|
|
|
|
|
|
#include <libgimpcolor/gimpcolortypes.h>
|
|
#include <libgimpmath/gimpmathtypes.h>
|
|
|
|
#include <libgimpbase/gimpbaseenums.h>
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* For information look into the C source or the html documentation */
|
|
|
|
|
|
/* XXX FIXME move these to a separate file */
|
|
|
|
#ifdef GIMP_DISABLE_DEPRECATION_WARNINGS
|
|
#define GIMP_DEPRECATED
|
|
#define GIMP_DEPRECATED_FOR(f)
|
|
#define GIMP_UNAVAILABLE(maj,min)
|
|
#else
|
|
#define GIMP_DEPRECATED G_DEPRECATED
|
|
#define GIMP_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f)
|
|
#define GIMP_UNAVAILABLE(maj,min) G_UNAVAILABLE(maj,min)
|
|
#endif
|
|
|
|
|
|
typedef struct _GimpChoice GimpChoice;
|
|
typedef struct _GimpParasite GimpParasite;
|
|
typedef struct _GimpEnumDesc GimpEnumDesc;
|
|
typedef struct _GimpFlagsDesc GimpFlagsDesc;
|
|
typedef struct _GimpUnit GimpUnit;
|
|
typedef struct _GimpValueArray GimpValueArray;
|
|
|
|
typedef struct _GimpMetadata GimpMetadata;
|
|
|
|
|
|
/**
|
|
* GimpEnumDesc:
|
|
* @value: An enum value.
|
|
* @value_desc: The value's description.
|
|
* @value_help: The value's help text.
|
|
*
|
|
* This structure is used to register translatable descriptions and
|
|
* help texts for enum values. See gimp_enum_set_value_descriptions().
|
|
**/
|
|
struct _GimpEnumDesc
|
|
{
|
|
gint value;
|
|
const gchar *value_desc;
|
|
const gchar *value_help;
|
|
};
|
|
|
|
/**
|
|
* GimpFlagsDesc:
|
|
* @value: A flag value.
|
|
* @value_desc: The value's description.
|
|
* @value_help: The value's help text.
|
|
*
|
|
* This structure is used to register translatable descriptions and
|
|
* help texts for flag values. See gimp_flags_set_value_descriptions().
|
|
**/
|
|
struct _GimpFlagsDesc
|
|
{
|
|
guint value;
|
|
const gchar *value_desc;
|
|
const gchar *value_help;
|
|
};
|
|
|
|
|
|
void gimp_type_set_translation_domain (GType type,
|
|
const gchar *domain);
|
|
const gchar * gimp_type_get_translation_domain (GType type);
|
|
|
|
void gimp_type_set_translation_context (GType type,
|
|
const gchar *context);
|
|
const gchar * gimp_type_get_translation_context (GType type);
|
|
|
|
void gimp_enum_set_value_descriptions (GType enum_type,
|
|
const GimpEnumDesc *descriptions);
|
|
const GimpEnumDesc * gimp_enum_get_value_descriptions (GType enum_type);
|
|
|
|
void gimp_flags_set_value_descriptions (GType flags_type,
|
|
const GimpFlagsDesc *descriptions);
|
|
const GimpFlagsDesc * gimp_flags_get_value_descriptions (GType flags_type);
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GIMP_BASE_TYPES_H__ */
|