glib/gobject/gvaluearray.h
Emmanuele Bassi 3c53fb8790 Move the GLib type system into libglib
The type system should have never been relegated to libgobject: it's a low
level API to register types at run time.

Having GType inside libglib allows us to use the type system information
everywhere:

- generic but type safe storage data types
- explicit memory management semantics for all data types
- enumeration types for all flags

Having the type system inside libglib also allows us to create new and
better fundamental types in the future, like sum types, option types,
tuples, and generic types.

Moved:

- gatomicarray
- gboxed
- genums
- gtype
- gtypeplugin
- gvalue

The move is mostly Git surgery, but given the amount of internal API
surface, it results in a single commit to avoid breaking bisectability.

We need to maintain `gobject/gvaluecollector.h` as a publicly installed
header but, to avoid issues in case of excessive inclusions, we make it
conflict with `glib/gvaluecollector.h`.

See: #2370

See: https://discourse.gnome.org/t/straw-man-moving-the-gtype-api-down-to-libglib-2-0/11169
2025-01-03 22:56:56 +00:00

101 lines
3.1 KiB
C

/* GObject - GLib Type, Object, Parameter and Signal Library
* Copyright (C) 2001 Red Hat, Inc.
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* 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 2.1 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 <http://www.gnu.org/licenses/>.
*
* gvaluearray.h: GLib array type holding GValues
*/
#ifndef __G_VALUE_ARRAY_H__
#define __G_VALUE_ARRAY_H__
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
#error "Only <glib-object.h> can be included directly."
#endif
#include <glib.h>
#include <gobject/gobject-visibility.h>
G_BEGIN_DECLS
/**
* G_TYPE_VALUE_ARRAY:
*
* The type ID of the "GValueArray" type which is a boxed type,
* used to pass around pointers to GValueArrays.
*
* Deprecated: 2.32: Use #GArray instead of #GValueArray
*/
#define G_TYPE_VALUE_ARRAY (g_value_array_get_type ()) GOBJECT_DEPRECATED_MACRO_IN_2_32_FOR(G_TYPE_ARRAY)
/* --- typedefs & structs --- */
typedef struct _GValueArray GValueArray;
struct _GValueArray
{
guint n_values;
GValue *values;
/*< private >*/
guint n_prealloced;
};
/* --- prototypes --- */
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GType g_value_array_get_type (void) G_GNUC_CONST;
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValue* g_value_array_get_nth (GValueArray *value_array,
guint index_);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_new (guint n_prealloced);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
void g_value_array_free (GValueArray *value_array);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_copy (const GValueArray *value_array);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_prepend (GValueArray *value_array,
const GValue *value);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_append (GValueArray *value_array,
const GValue *value);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_insert (GValueArray *value_array,
guint index_,
const GValue *value);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_remove (GValueArray *value_array,
guint index_);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_sort (GValueArray *value_array,
GCompareFunc compare_func);
GOBJECT_DEPRECATED_IN_2_32_FOR(GArray)
GValueArray* g_value_array_sort_with_data (GValueArray *value_array,
GCompareDataFunc compare_func,
gpointer user_data);
G_END_DECLS
#endif /* __G_VALUE_ARRAY_H__ */