89c359ce47
GLib has a specific type for byte arrays: `GBytes` (and it's underlying GType `G_TYPE_BYTES`). By using this type, we can avoid having a `GimpUint8Array` which is a bit cumbersome to use for both the C API, as well as bindings. By using `GBytes`, we allow other languages to pass on byte arrays as they are used to, while the bindings will make sure to do the right thing. In the end, it makes the API a little bit simpler for everyone, and reduces confusion for people who are used to working with byte arrays in other C/GLib based code (and not having 2 different types to denote the same thing). Related: https://gitlab.gnome.org/GNOME/gimp/-/issues/5919
115 lines
4.2 KiB
C
115 lines
4.2 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
|
|
*
|
|
* gimpparasite.h
|
|
* Copyright (C) 1998 Jay Cox <jaycox@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
|
|
* 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/>.
|
|
*/
|
|
|
|
#if !defined (__GIMP_BASE_H_INSIDE__) && !defined (GIMP_BASE_COMPILATION)
|
|
#error "Only <libgimpbase/gimpbase.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __GIMP_PARASITE_H__
|
|
#define __GIMP_PARASITE_H__
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* For information look into the C source or the html documentation */
|
|
|
|
|
|
/*
|
|
* GIMP_TYPE_PARASITE
|
|
*/
|
|
|
|
#define GIMP_TYPE_PARASITE (gimp_parasite_get_type ())
|
|
#define GIMP_VALUE_HOLDS_PARASITE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_PARASITE))
|
|
|
|
GType gimp_parasite_get_type (void) G_GNUC_CONST;
|
|
|
|
|
|
/*
|
|
* GIMP_TYPE_PARAM_PARASITE
|
|
*/
|
|
|
|
#define GIMP_TYPE_PARAM_PARASITE (gimp_param_parasite_get_type ())
|
|
#define GIMP_IS_PARAM_SPEC_PARASITE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_PARASITE))
|
|
|
|
typedef struct _GimpParamSpecParasite GimpParamSpecParasite;
|
|
|
|
GType gimp_param_parasite_get_type (void) G_GNUC_CONST;
|
|
|
|
GParamSpec * gimp_param_spec_parasite (const gchar *name,
|
|
const gchar *nick,
|
|
const gchar *blurb,
|
|
GParamFlags flags);
|
|
|
|
|
|
#define GIMP_PARASITE_PERSISTENT 1
|
|
#define GIMP_PARASITE_UNDOABLE 2
|
|
|
|
#define GIMP_PARASITE_ATTACH_PARENT (0x80 << 8)
|
|
#define GIMP_PARASITE_PARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 8)
|
|
#define GIMP_PARASITE_PARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 8)
|
|
|
|
#define GIMP_PARASITE_ATTACH_GRANDPARENT (0x80 << 16)
|
|
#define GIMP_PARASITE_GRANDPARENT_PERSISTENT (GIMP_PARASITE_PERSISTENT << 16)
|
|
#define GIMP_PARASITE_GRANDPARENT_UNDOABLE (GIMP_PARASITE_UNDOABLE << 16)
|
|
|
|
|
|
/**
|
|
* GimpParasite:
|
|
* @name: the parasite name, USE A UNIQUE PREFIX
|
|
* @flags: the parasite flags, like save in XCF etc.
|
|
* @size: the parasite size in bytes
|
|
* @data: (array length=size): the parasite data, the owner os the parasite is responsible
|
|
* for tracking byte order and internal structure
|
|
**/
|
|
struct _GimpParasite
|
|
{
|
|
gchar *name;
|
|
guint32 flags;
|
|
guint32 size;
|
|
gpointer data;
|
|
};
|
|
|
|
|
|
GimpParasite * gimp_parasite_new (const gchar *name,
|
|
guint32 flags,
|
|
guint32 size,
|
|
gconstpointer data);
|
|
void gimp_parasite_free (GimpParasite *parasite);
|
|
|
|
GimpParasite * gimp_parasite_copy (const GimpParasite *parasite);
|
|
|
|
gboolean gimp_parasite_compare (const GimpParasite *a,
|
|
const GimpParasite *b);
|
|
|
|
gboolean gimp_parasite_is_type (const GimpParasite *parasite,
|
|
const gchar *name);
|
|
gboolean gimp_parasite_is_persistent (const GimpParasite *parasite);
|
|
gboolean gimp_parasite_is_undoable (const GimpParasite *parasite);
|
|
gboolean gimp_parasite_has_flag (const GimpParasite *parasite,
|
|
gulong flag);
|
|
gulong gimp_parasite_get_flags (const GimpParasite *parasite);
|
|
const gchar * gimp_parasite_get_name (const GimpParasite *parasite);
|
|
|
|
gconstpointer gimp_parasite_get_data (const GimpParasite *parasite,
|
|
guint32 *num_bytes);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GIMP_PARASITE_H__ */
|