gimp/libgimp/gimpprocedure-params.h

1129 lines
64 KiB
C
Raw Normal View History

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
*
* gimpprocedure-params.h
* Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
*
* 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/>.
*/
#if !defined (__GIMP_H_INSIDE__) && !defined (GIMP_COMPILATION)
#error "Only <libgimp/gimp.h> can be included directly."
#endif
#ifndef __GIMP_PROCEDURE_PARAMS_H__
#define __GIMP_PROCEDURE_PARAMS_H__
G_BEGIN_DECLS
/* For information look into the C source or the html documentation */
/**
* SECTION: gimpprocedure-params
* @title: GimpProcedure-params
* @short_description: Macros and defines to add procedure arguments
* and return values.
*
* Macros and defines to add procedure arguments and return values.
**/
/* boolean */
#define GIMP_VALUES_GET_BOOLEAN(args, n) \
g_value_get_boolean (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_BOOLEAN(args, n, value) \
g_value_set_boolean (gimp_value_array_index (args, n), value)
/* int */
#define GIMP_VALUES_GET_INT(args, n) \
g_value_get_int (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_INT(args, n, value) \
g_value_set_int (gimp_value_array_index (args, n), value)
/* uint */
#define GIMP_VALUES_GET_UINT(args, n) \
g_value_get_uint (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_UINT(args, n, value) \
g_value_set_uint (gimp_value_array_index (args, n), value)
/* uchar */
#define GIMP_VALUES_GET_UCHAR(args, n) \
g_value_get_uchar (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_UCHAR(args, n, value) \
g_value_set_uchar (gimp_value_array_index (args, n), value)
/* double */
#define GIMP_VALUES_GET_DOUBLE(args, n) \
g_value_get_double (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_DOUBLE(args, n, value) \
g_value_set_double (gimp_value_array_index (args, n), value)
/* enum */
#define GIMP_VALUES_GET_ENUM(args, n) \
g_value_get_enum (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_ENUM(args, n, value) \
g_value_set_enum (gimp_value_array_index (args, n), value)
/* choice */
#define GIMP_VALUES_GET_CHOICE(args, n) \
g_value_get_int (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_CHOICE(args, n, value) \
g_value_set_int (gimp_value_array_index (args, n), value)
/* string */
#define GIMP_VALUES_GET_STRING(args, n) \
g_value_get_string (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_STRING(args, n) \
g_value_dup_string (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_STRING(args, n, value) \
g_value_set_string (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_STRING(args, n, value) \
g_value_take_string (gimp_value_array_index (args, n), value)
/* color */
/* TODO:
* 1. has_alpha is currently bogus and doesn't do anything yet.
* 2. Also wouldn't none_ok be useful for color arguments (accepting a NULL
* GeglColor)?
* 3. GEGL also provides a gegl_param_spec_color_from_string() allowing to
* initialize the default with a list of standard colors. Wouldn't it be
* interesting to also have this?
*/
#define GIMP_VALUES_GET_COLOR(args, n, value) \
g_value_get_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_SET_COLOR(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* parasite */
#define GIMP_VALUES_GET_PARASITE(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_PARASITE(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PARASITE(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_PARASITE(args, n, value) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* param */
#define GIMP_VALUES_GET_PARAM(args, n) \
g_value_get_param (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_PARAM(args, n) \
g_value_dup_param (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PARAM(args, n, value) \
g_value_set_param (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_PARAM(args, n, value) \
g_value_take_param (gimp_value_array_index (args, n), value)
/* bytes */
#define GIMP_VALUES_GET_BYTES(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_BYTES(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
app, libgimp*, pdb, plug-ins: reimplement generic inter-process transient window. Having windows ID as guint32 is a mistake. Different systems have different protocols. In Wayland in particular, Windows handles are exchanged as strings. What this commit does is the following: In core: - get_window_id() virtual function in core GimpProgress is changed to return a GBytes, as a generic "data" to represent a window differently on different systems. - All implementations of get_window_id() in various classes implementing this interface are updated accordingly: * GimpSubProgress * GimpDisplay returns the handle of its shell. * GimpDisplayShell now creates its window handle at construction with libgimpwidget's gimp_widget_set_native_handle() and simply return this handle every time it's requested. * GimpFileDialog also creates its window handle at construction with gimp_widget_set_native_handle(). - gimp_window_set_transient_for() in core is changed to take a GimpProgress as argument (instead of a guint32 ID), requests and process the ID itself, according to the running platform. In particular, the following were improved: * Unlike old code, it will work even if the window is not visible yet. In such a case, the function simply adds a signal handler to set transient at mapping. It makes it easier to use it at construction in a reliable way. * It now works for Wayland too, additionally to X11. - GimpPdbProgress now exchanges a GBytes too with the command GIMP_PROGRESS_COMMAND_GET_WINDOW. - display_get_window_id() in gimp-gui.h also returns a GBytes now. PDB/libgimp: - gimp_display_get_window_handle() and gimp_progress_get_window_handle() now return a GBytes to represent a window handle in an opaque way (depending on the running platform). In libgimp: - GimpProgress's get_window() virtual function changed to return a GBytes and renamed get_window_handle(). - In particular GimpProgressBar is the only implementation of get_window_handle(). It creates its handle at object construction with libgimpwidget's gimp_widget_set_native_handle() and the virtual method's implementation simply returns the GBytes. In libgimpUi: - gimp_ui_get_display_window() and gimp_ui_get_progress_window() were removed. We should not assume anymore that it is possible to create a GdkWindow to be used. For instance this is not possible with Wayland which has its own way to set a window transient with a string handle. - gimp_window_set_transient_for_display() and gimp_window_set_transient() now use an internal implementation similar to core gimp_window_set_transient_for(), with the same improvements (works even at construction when the window is not visible yet + works for Wayland too). In libgimpwidgets: - New gimp_widget_set_native_handle() is a helper function used both in core and libgimp* libraries for widgets which we want to be usable as possible parents. It takes care of getting the relevant window handle (depending on the running platform) and stores it in a given pointer, either immediately or after a callback once the widget is mapped. So it can be used at construction. Also it sets a handle for X11 or Wayland. In plug-ins: - Screenshot uses the new gimp_progress_get_window_handle() directly now in its X11 code path and creates out of it a GdkWindows itself with gdk_x11_window_foreign_new_for_display(). Our inter-process transient implementation only worked for X11, and with this commit, it works for Wayland too. There is code for Windows but it is currently disabled as it apparently hangs (there is a comment in-code which links to this old report: https://bugzilla.gnome.org/show_bug.cgi?id=359538). NikcDC tested yesterday with re-enabling the code and said they experienced a freeze. ;-( Finally there is no infrastructure yet to make this work on macOS and apparently there is no implementation of window handle in GDK for macOS that I could find. I'm not sure if macOS doesn't have this concept of setting transient on another processus's window or GDK is simply lacking the implementation.
2023-08-14 14:23:06 +02:00
#define GIMP_VALUES_SET_BYTES(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_BYTES(args, n, value, length) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* int32 array */
#define GIMP_VALUES_GET_INT32_ARRAY(args, n, length) \
gimp_value_get_int32_array (gimp_value_array_index (args, n), length)
#define GIMP_VALUES_DUP_INT32_ARRAY(args, n, length) \
gimp_value_dup_int32_array (gimp_value_array_index (args, n), length)
#define GIMP_VALUES_SET_INT32_ARRAY(args, n, value, length) \
gimp_value_set_int32_array (gimp_value_array_index (args, n), value, length)
#define GIMP_VALUES_TAKE_INT32_ARRAY(args, n, value, length) \
gimp_value_take_int32_array (gimp_value_array_index (args, n), value, length)
/* float array */
#define GIMP_VALUES_GET_FLOAT_ARRAY(args, n, length) \
gimp_value_get_float_array (gimp_value_array_index (args, n), length)
#define GIMP_VALUES_DUP_FLOAT_ARRAY(args, n, length) \
gimp_value_dup_float_array (gimp_value_array_index (args, n), length)
#define GIMP_VALUES_SET_FLOAT_ARRAY(args, n, value, length) \
gimp_value_set_float_array (gimp_value_array_index (args, n), value, length)
#define GIMP_VALUES_TAKE_FLOAT_ARRAY(args, n, value, length) \
gimp_value_take_float_array (gimp_value_array_index (args, n), value, length)
/* string array (strv) */
#define GIMP_VALUES_GET_STRV(args, n) \
g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_STRV(args, n) \
g_value_dup_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_STRV(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_STRV(args, n, value) \
g_value_take_boxed (gimp_value_array_index (args, n), value)
/* object array */
#define GIMP_VALUES_GET_CORE_OBJECT_ARRAY(args, n) \
(gpointer) g_value_get_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_CORE_OBJECT_ARRAY(args, n) \
(gpointer) g_value_dup_boxed (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_CORE_OBJECT_ARRAY(args, n, value) \
g_value_set_boxed (gimp_value_array_index (args, n), (gconstpointer) value)
#define GIMP_VALUES_TAKE_CORE_OBJECT_ARRAY(args, n, value) \
g_value_take_boxed (gimp_value_array_index (args, n), (gconstpointer) value)
/* display */
#define GIMP_VALUES_GET_DISPLAY(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_DISPLAY_ID(args, n) \
gimp_display_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_DISPLAY(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* image */
#define GIMP_VALUES_GET_IMAGE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_IMAGE_ID(args, n) \
gimp_image_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_IMAGE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* item */
#define GIMP_VALUES_GET_ITEM(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_ITEM_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_ITEM(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* drawable */
#define GIMP_VALUES_GET_DRAWABLE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_DRAWABLE_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_DRAWABLE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* layer */
#define GIMP_VALUES_GET_LAYER(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_LAYER_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_LAYER(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* text layer */
#define GIMP_VALUES_GET_TEXT_LAYER(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_TEXT_LAYER_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_TEXT_LAYER(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* group layer */
#define GIMP_VALUES_GET_GROUP_LAYER(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_GROUP_LAYER_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_GROUP_LAYER(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* channel */
#define GIMP_VALUES_GET_CHANNEL(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_CHANNEL_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_CHANNEL(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* layer mask */
#define GIMP_VALUES_GET_LAYER_MASK(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_LAYER_MASK_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_LAYER_MASK(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* selection */
#define GIMP_VALUES_GET_SELECTION(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_SELECTION_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_SELECTION(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* path */
#define GIMP_VALUES_GET_PATH(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_GET_PATH_ID(args, n) \
gimp_item_get_id (g_value_get_object (gimp_value_array_index (args, n)))
#define GIMP_VALUES_SET_PATH(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
/* file */
#define GIMP_VALUES_GET_FILE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_DUP_FILE(args, n) \
g_value_dup_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_FILE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_TAKE_FILE(args, n, value) \
g_value_take_object (gimp_value_array_index (args, n), value)
/* Resource */
#define GIMP_VALUES_GET_RESOURCE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_RESOURCE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_BRUSH(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_BRUSH(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_FONT(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_FONT(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_GRADIENT(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_GRADIENT(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_PALETTE(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PALETTE(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
#define GIMP_VALUES_GET_PATTERN(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_PATTERN(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
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-07-25 20:55:21 +02:00
/* Unit */
#define GIMP_VALUES_GET_UNIT(args, n) \
g_value_get_object (gimp_value_array_index (args, n))
#define GIMP_VALUES_SET_UNIT(args, n, value) \
g_value_set_object (gimp_value_array_index (args, n), value)
void gimp_procedure_add_boolean_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean value,
GParamFlags flags);
void gimp_procedure_add_boolean_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean value,
GParamFlags flags);
void gimp_procedure_add_boolean_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean value,
GParamFlags flags);
void gimp_procedure_add_int_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gint min,
gint max,
gint value,
GParamFlags flags);
void gimp_procedure_add_int_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gint min,
gint max,
gint value,
GParamFlags flags);
void gimp_procedure_add_int_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gint min,
gint max,
gint value,
GParamFlags flags);
void gimp_procedure_add_uint_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
guint min,
guint max,
guint value,
GParamFlags flags);
void gimp_procedure_add_uint_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
guint min,
guint max,
guint value,
GParamFlags flags);
void gimp_procedure_add_uint_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
guint min,
guint max,
guint value,
GParamFlags flags);
void gimp_procedure_add_unit_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean show_pixels,
gboolean show_percent,
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-07-25 20:55:21 +02:00
GimpUnit *value,
GParamFlags flags);
void gimp_procedure_add_unit_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean show_pixels,
gboolean show_percent,
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-07-25 20:55:21 +02:00
GimpUnit *value,
GParamFlags flags);
void gimp_procedure_add_unit_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean show_pixels,
gboolean show_percent,
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-07-25 20:55:21 +02:00
GimpUnit *value,
GParamFlags flags);
void gimp_procedure_add_double_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gdouble min,
gdouble max,
gdouble value,
GParamFlags flags);
void gimp_procedure_add_double_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gdouble min,
gdouble max,
gdouble value,
GParamFlags flags);
void gimp_procedure_add_double_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gdouble min,
gdouble max,
gdouble value,
GParamFlags flags);
void gimp_procedure_add_enum_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType enum_type,
gint value,
GParamFlags flags);
void gimp_procedure_add_enum_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType enum_type,
gint value,
GParamFlags flags);
void gimp_procedure_add_enum_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType enum_type,
gint value,
GParamFlags flags);
void gimp_procedure_add_choice_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpChoice *choice,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_choice_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpChoice *choice,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_choice_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpChoice *choice,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_string_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_string_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_string_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_color_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
GeglColor *value,
GParamFlags flags);
void gimp_procedure_add_color_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
GeglColor *value,
GParamFlags flags);
void gimp_procedure_add_color_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
GeglColor *value,
GParamFlags flags);
void gimp_procedure_add_color_from_string_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_color_from_string_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_color_from_string_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean has_alpha,
const gchar *value,
GParamFlags flags);
void gimp_procedure_add_parasite_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_parasite_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_parasite_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_param_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType param_type,
GParamFlags flags);
void gimp_procedure_add_param_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType param_type,
GParamFlags flags);
void gimp_procedure_add_param_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType param_type,
GParamFlags flags);
void gimp_procedure_add_bytes_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_bytes_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_bytes_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_int32_array_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_int32_array_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_int32_array_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_float_array_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_float_array_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_float_array_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_string_array_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_string_array_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_string_array_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_core_object_array_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType object_type,
GParamFlags flags);
void gimp_procedure_add_core_object_array_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType object_type,
GParamFlags flags);
void gimp_procedure_add_core_object_array_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GType object_type,
GParamFlags flags);
void gimp_procedure_add_display_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_display_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_display_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_image_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_image_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_image_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_item_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_item_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_item_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_drawable_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_drawable_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_drawable_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_text_layer_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_text_layer_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_text_layer_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_group_layer_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_group_layer_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_group_layer_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_channel_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_channel_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_channel_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_mask_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_mask_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_layer_mask_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_selection_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_selection_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_selection_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_path_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_path_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_path_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GParamFlags flags);
void gimp_procedure_add_file_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_file_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_file_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_resource_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpResource *default_value,
GParamFlags flags);
void gimp_procedure_add_resource_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpResource *default_value,
GParamFlags flags);
void gimp_procedure_add_resource_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_brush_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpBrush *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_brush_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpBrush *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_brush_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_font_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpFont *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_font_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpFont *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_font_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_gradient_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpGradient *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_gradient_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpGradient *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_gradient_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_palette_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpPalette *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_palette_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpPalette *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_palette_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
void gimp_procedure_add_pattern_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
gboolean none_ok,
GimpPattern *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_pattern_aux_argument (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GimpPattern *default_value,
gboolean default_to_context,
GParamFlags flags);
void gimp_procedure_add_pattern_return_value (GimpProcedure *procedure,
const gchar *name,
const gchar *nick,
const gchar *blurb,
GParamFlags flags);
G_END_DECLS
#endif /* __GIMP_PROCEDURE_PARAMS_H__ */