mirror of
https://gitlab.gnome.org/GNOME/gimp.git
synced 2025-07-03 17:33:25 +00:00
392f00baf5
Turn all ID param specs into object param specs (e.g. GimpParamImageID becomes GimpParamImage) and convert between IDs and objects in gimpgpparams.c directly above the the wire protocol, so all of app/, libgimp/ and plug-ins/ can deal directly with objects down to the lowest level and not care about IDs. Use the actual object param specs for procedure arguments and return values again instead of a plain g_param_spec_object() and bring back the none_ok parameter. This implies changing the PDB type checking functions to work on pure integers instead of IDs (one can't check whether object creation is possible if performing that check requires the object to already exist). For example gimp_foo_is_valid() becomes gimp_foo_id_is_valid() and is not involved in automatic object creation magic at the protocol level. Added wrappers which still say gimp_foo_is_valid() and take the respective objects. Adapted all code, and it all becomes nicer and less convoluted, even the generated PDB wrappers in app/ and libgimp/.
413 lines
9.4 KiB
C
413 lines
9.4 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995-2000 Peter Mattis and Spencer Kimball
|
|
*
|
|
* gimpitem.c
|
|
* Copyright (C) Jehan
|
|
*
|
|
* 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
|
|
* Lesser 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/>.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include "gimp.h"
|
|
|
|
#include "libgimpbase/gimpwire.h" /* FIXME kill this include */
|
|
|
|
#include "gimpplugin-private.h"
|
|
#include "gimpprocedure-private.h"
|
|
|
|
|
|
enum
|
|
{
|
|
PROP_0,
|
|
PROP_ID,
|
|
N_PROPS
|
|
};
|
|
|
|
|
|
struct _GimpItemPrivate
|
|
{
|
|
gint id;
|
|
};
|
|
|
|
|
|
static void gimp_item_set_property (GObject *object,
|
|
guint property_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec);
|
|
static void gimp_item_get_property (GObject *object,
|
|
guint property_id,
|
|
GValue *value,
|
|
GParamSpec *pspec);
|
|
|
|
|
|
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GimpItem, gimp_item, G_TYPE_OBJECT)
|
|
|
|
#define parent_class gimp_item_parent_class
|
|
|
|
static GParamSpec *props[N_PROPS] = { NULL, };
|
|
|
|
|
|
static void
|
|
gimp_item_class_init (GimpItemClass *klass)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (klass);
|
|
|
|
object_class->set_property = gimp_item_set_property;
|
|
object_class->get_property = gimp_item_get_property;
|
|
|
|
props[PROP_ID] =
|
|
g_param_spec_int ("id",
|
|
"The item id",
|
|
"The item id for internal use",
|
|
0, G_MAXINT32, 0,
|
|
GIMP_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT_ONLY);
|
|
|
|
g_object_class_install_properties (object_class, N_PROPS, props);
|
|
}
|
|
|
|
static void
|
|
gimp_item_init (GimpItem *item)
|
|
{
|
|
item->priv = gimp_item_get_instance_private (item);
|
|
}
|
|
|
|
static void
|
|
gimp_item_set_property (GObject *object,
|
|
guint property_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
GimpItem *item = GIMP_ITEM (object);
|
|
|
|
switch (property_id)
|
|
{
|
|
case PROP_ID:
|
|
item->priv->id = g_value_get_int (value);
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
gimp_item_get_property (GObject *object,
|
|
guint property_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
GimpItem *item = GIMP_ITEM (object);
|
|
|
|
switch (property_id)
|
|
{
|
|
case PROP_ID:
|
|
g_value_set_int (value, item->priv->id);
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
/* Public API. */
|
|
|
|
|
|
/**
|
|
* gimp_item_get_id:
|
|
* @item: The item.
|
|
*
|
|
* Returns: the item ID.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
gint32
|
|
gimp_item_get_id (GimpItem *item)
|
|
{
|
|
return item ? item->priv->id : -1;
|
|
}
|
|
|
|
/**
|
|
* gimp_item_get_by_id:
|
|
* @item_id: The item id.
|
|
*
|
|
* Returns a #GimpItem representing @item_id. Since #GimpItem is an
|
|
* abstract class, the real object type will actually be the proper
|
|
* subclass.
|
|
*
|
|
* Returns: (nullable) (transfer none): a #GimpItem for @item_id or
|
|
* %NULL if @item_id does not represent a valid item.
|
|
* The object belongs to libgimp and you must not modify
|
|
* or unref it.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
GimpItem *
|
|
gimp_item_get_by_id (gint32 item_id)
|
|
{
|
|
if (item_id > 0)
|
|
{
|
|
GimpPlugIn *plug_in = gimp_get_plug_in ();
|
|
GimpProcedure *procedure = _gimp_plug_in_get_procedure (plug_in);
|
|
|
|
return _gimp_procedure_get_item (procedure, item_id);
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_valid:
|
|
* @item: The item to check.
|
|
*
|
|
* Returns TRUE if the item is valid.
|
|
*
|
|
* This procedure checks if the given item is valid and refers to an
|
|
* existing item.
|
|
*
|
|
* Returns: Whether the item is valid.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_valid (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_valid (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_drawable:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a drawable.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a drawable.
|
|
*
|
|
* Returns: TRUE if the item is a drawable, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_drawable (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_drawable (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_layer:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a layer.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a layer.
|
|
*
|
|
* Returns: TRUE if the item is a layer, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_layer (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_layer (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_text_layer:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a text layer.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a text
|
|
* layer.
|
|
*
|
|
* Returns: TRUE if the item is a text layer, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_text_layer (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_text_layer (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_channel:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a channel.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a channel.
|
|
*
|
|
* Returns: TRUE if the item is a channel, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_channel (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_channel (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_layer_mask:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a layer mask.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a layer
|
|
* mask.
|
|
*
|
|
* Returns: TRUE if the item is a layer mask, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_layer_mask (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_layer_mask (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_selection:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a selection.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a selection.
|
|
*
|
|
* Returns: TRUE if the item is a selection, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_selection (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_selection (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_is_vectors:
|
|
* @item: The item.
|
|
*
|
|
* Returns whether the item is a vectors.
|
|
*
|
|
* This procedure returns TRUE if the specified item is a vectors.
|
|
*
|
|
* Returns: TRUE if the item is a vectors, FALSE otherwise.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gboolean
|
|
gimp_item_is_vectors (GimpItem *item)
|
|
{
|
|
return gimp_item_id_is_vectors (gimp_item_get_id (item));
|
|
}
|
|
|
|
/**
|
|
* gimp_item_get_children:
|
|
* @item: The item.
|
|
* @num_children: (out): The number of items in the returned array.
|
|
*
|
|
* Returns the item's list of children.
|
|
*
|
|
* This procedure returns the list of items which are children of the
|
|
* specified item. The order is topmost to bottommost.
|
|
*
|
|
* Returns: (array length=num_children) (transfer container):
|
|
* The item's list of children.
|
|
* The returned array must be freed with g_free(). Item
|
|
* elements belong to libgimp and must not be unrefed.
|
|
**/
|
|
GimpItem **
|
|
gimp_item_get_children (GimpItem *item,
|
|
gint *num_children)
|
|
{
|
|
GimpItem **children;
|
|
gint *ids;
|
|
gint i;
|
|
|
|
ids = _gimp_item_get_children (item, num_children);
|
|
|
|
children = g_new (GimpItem *, *num_children);
|
|
|
|
for (i = 0; i < *num_children; i++)
|
|
children[i] = gimp_item_get_by_id (ids[i]);
|
|
|
|
g_free (ids);
|
|
|
|
return children;
|
|
}
|
|
|
|
/**
|
|
* gimp_item_list_children:
|
|
* @item: The item.
|
|
*
|
|
* Returns the item's list of children.
|
|
*
|
|
* This procedure returns the list of items which are children of the
|
|
* specified item. The order is topmost to bottommost.
|
|
*
|
|
* Returns: (element-type GimpItem) (transfer container):
|
|
* The item's list of children.
|
|
* The returned ist must be freed with g_list_free(). Item
|
|
* elements belong to libgimp and must not be unrefed.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
GList *
|
|
gimp_item_list_children (GimpItem *item)
|
|
{
|
|
GList *children = NULL;
|
|
gint *ids;
|
|
gint num_items;
|
|
gint i;
|
|
|
|
ids = _gimp_item_get_children (item, &num_items);
|
|
|
|
for (i = 0; i < num_items; i++)
|
|
children = g_list_prepend (children, gimp_item_get_by_id (ids[i]));
|
|
|
|
g_free (ids);
|
|
|
|
return g_list_reverse (children);
|
|
}
|
|
|
|
/**
|
|
* gimp_item_get_children_deprecated: (skip)
|
|
* @item_id: The item.
|
|
* @num_children: (out): The item's number of children.
|
|
*
|
|
* Returns the item's list of children.
|
|
*
|
|
* This procedure returns the list of items which are children of the
|
|
* specified item. The order is topmost to bottommost.
|
|
*
|
|
* Returns: (array length=num_children) (element-type gint32) (transfer full):
|
|
* The item's list of children.
|
|
* The returned value must be freed with g_free().
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
gint *
|
|
gimp_item_get_children_deprecated (gint32 item_id,
|
|
gint *num_children)
|
|
{
|
|
return _gimp_item_get_children (gimp_item_get_by_id (item_id),
|
|
num_children);
|
|
}
|