luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity
cc627ea0df
glib/girepository/giobjectinfo.c

1211 lines
35 KiB
C
Raw Normal View History

Add Emacs mode lines to C sources
2012-02-03 19:42:56 +01:00
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
* GObject introspection: Object implementation
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
*
* Copyright (C) 2005 Matthias Clasen
* Copyright (C) 2008,2009 Red Hat, Inc.
*
girepository: Add SPDX license header to all obvious files Add the SPDX license runes to all the files which have an obvious copyright header already. This is a mechanical edit. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3155
2023-10-25 18:10:10 +02:00
* SPDX-License-Identifier: LGPL-2.1-or-later
*
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
* 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 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
girepository: Include config.h First in All Sources This includes config.h in all the C-sources of girepository so that we can get the correct export directive from config.h during compile time and therefore export the symbols as necessary, like what GLib and GTK+ is currently doing. https://bugzilla.gnome.org/show_bug.cgi?id=732669
2014-07-04 12:27:41 +02:00
#include "config.h"
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
#include <glib.h>
girepository: Use subdir paths in #includes The pkg-config file sets the include directory to the level above `girepository/`, just like with GIO, GObject and GModule. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3155
2023-10-25 18:45:42 +02:00
#include <girepository/girepository.h>
girepository: Port GIBaseInfo to GTypeInstance This adds more type safety to libgirepository, and allows differentiating the `GIBaseInfo` derived types using the type system. Two new derived types had to be added (previously they were just a collection of helper methods which worked directly on a `GIBaseInfo` and didn’t check types): `GICallbackInfo` and `GIUnresolvedInfo`. Further cleanups and refactoring might be needed on this, but the core of libgirepository now uses `GTypeInstance` and appears to still work (it’s difficult to be entirely sure because there are no unit tests yet). Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-28 18:24:20 +01:00
#include "gibaseinfo-private.h"
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
#include "girepository-private.h"
#include "gitypelib-internal.h"
girepository: Add missing includes of corresponding headers Make sure that each C file in `girepository/` includes its corresponding header file (if such a file exists). This ensures that the first declaration the compiler sees for each function contains the symbol visibility macros. This fixes symbol export (`dllexport`) on Windows platforms. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3155
2023-10-25 19:11:38 +02:00
#include "giobjectinfo.h"
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* GIObjectInfo:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* `GIObjectInfo` represents a classed type.
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Classed types in [type@GObject.Type] inherit from
* [type@GObject.TypeInstance]; the most common type is [class@GObject.Object].
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* A `GIObjectInfo` doesn’t represent a specific instance of a classed type,
* instead this represent the object type (i.e. the class).
docs: Remove DocBook tags We are still using gtk-doc, but gtk-doc uses Markdown these days, not DocBook.
2022-02-13 15:20:51 +01:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* A `GIObjectInfo` has methods, fields, properties, signals, interfaces,
docs: Remove DocBook tags We are still using gtk-doc, but gtk-doc uses Markdown these days, not DocBook.
2022-02-13 15:20:51 +01:00
* constants and virtual functions.
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
*
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_field_offset:
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
* @info: a #GIObjectInfo
* @n: index of queried field
*
* Obtain the offset of the specified field.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: field offset, in bytes
* Since: 2.80
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
*/
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
static size_t
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_field_offset (GIObjectInfo *info,
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t n)
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
Header *header = (Header *)rinfo->typelib->data;
ObjectBlob *blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
uint32_t offset;
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
FieldBlob *field_blob;
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2;
girepository: Use expected signed types for iterating We are using various indexes types, but not always using the correct sign or size, so let's adapt this to ensure we're consistent with the values we're comparing with.
2024-01-16 01:57:09 +01:00
for (size_t i = 0; i < n; i++)
g-ir-compiler: Add support for callback fields on GObjects Use ParseState enum instead of a boolean for the ParseContexts embedded_type flag. This allows specific tracking of the embedded type currently being parsed which can now either be STATE_STRUCT_FIELD or STATE_CLASS_FIELD (or allow for future expansion). Add ParseState::STATE_NONE as the default for this field. Fix GObject FieldBlob validation to take into account the sizeof CallbackBlobs (copied from the struct validator). Add static g_object_info_get_field_offset which parallels g_struct_info_get_field_offset which is needed since callback fields may vary in size. https://bugzilla.gnome.org/show_bug.cgi?id=725198
2014-02-27 11:05:54 +01:00
{
field_blob = (FieldBlob *)&rinfo->typelib->data[offset];
offset += header->field_blob_size;
if (field_blob->has_embedded_type)
offset += header->callback_blob_size;
}
return offset;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_parent:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the parent of the object type.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full) (nullable): The `GIObjectInfo`. Free the struct by
* calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIObjectInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_parent (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
if (blob->parent)
girepository: Remove `_` prefix from private functions Now that libgirepository uses `GI_AVAILABLE_IN_*` macros, that’s what controls symbol visibility. The `_` prefixes are redundant, and out of keeping with the rest of GLib. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 16:23:31 +01:00
return (GIObjectInfo *) gi_info_from_entry (rinfo->repository,
rinfo->typelib, blob->parent);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
else
return NULL;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_abstract:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain if the object type is an abstract type, i.e. if it cannot be
* instantiated.
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: `TRUE` if the object type is abstract
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
gboolean
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_abstract (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, FALSE);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), FALSE);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->abstract != 0;
}
Add "final" class attribute A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
2021-02-09 12:38:27 +01:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_final:
Add "final" class attribute A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
2021-02-09 12:38:27 +01:00
* @info: a #GIObjectInfo
*
* Checks whether the object type is a final type, i.e. if it cannot
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* be derived.
Add "final" class attribute A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
2021-02-09 12:38:27 +01:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: `TRUE` if the object type is final
girepository: Update existing Since tags to 2.80 Since the APIs are new to libgirepository-2.0 in version 2.80. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-09 00:24:11 +01:00
* Since: 2.80
Add "final" class attribute A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
2021-02-09 12:38:27 +01:00
*/
gboolean
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_final (GIObjectInfo *info)
Add "final" class attribute A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
2021-02-09 12:38:27 +01:00
{
GIRealInfo *rinfo = (GIRealInfo *) info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, FALSE);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), FALSE);
blob = (ObjectBlob *) &rinfo->typelib->data[rinfo->offset];
return blob->final_ != 0;
}
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_fundamental:
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain if the object type is of a fundamental type which is not
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* `G_TYPE_OBJECT`.
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* This is mostly for supporting `GstMiniObject`.
*
* Returns: `TRUE` if the object type is a fundamental type
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
gboolean
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_fundamental (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, FALSE);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), FALSE);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
return blob->fundamental != 0;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_type_name:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain the name of the object’s class/type.
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: name of the object’s type
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_type_name (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->gtype_name);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename get_type_init() methods to get_type_init_function_name() Because they return the function name, not a `GIFunctionInfo` for the function, or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 18:54:19 +01:00
* gi_object_info_get_type_init_function_name:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain the name of the function which, when called, will return the
* [type@GObject.Type] for this object type.
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: the type init function name
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *
girepository: Rename get_type_init() methods to get_type_init_function_name() Because they return the function name, not a `GIFunctionInfo` for the function, or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 18:54:19 +01:00
gi_object_info_get_type_init_function_name (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->gtype_init);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_interfaces:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of interfaces that this object type has.
*
* Returns: number of interfaces
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_interfaces (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_interfaces;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_interface:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of interface to get
*
* Obtain an object type interface at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.InterfaceInfo]. Free the
* struct by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIInterfaceInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_interface (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Remove `_` prefix from private functions Now that libgirepository uses `GI_AVAILABLE_IN_*` macros, that’s what controls symbol visibility. The `_` prefixes are redundant, and out of keeping with the rest of GLib. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 16:23:31 +01:00
return (GIInterfaceInfo *) gi_info_from_entry (rinfo->repository,
rinfo->typelib, blob->interfaces[n]);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_fields:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of fields that this object type has.
*
* Returns: number of fields
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_fields (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_fields;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_field:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of field to get
*
* Obtain an object type field at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.FieldInfo]. Free the struct
* by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIFieldInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_field (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
offset = gi_object_info_get_field_offset(info, n);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
gibaseinfo: Rename gi_info_new() to gi_base_info_new() It’s actually a factory method rather than a constructor, since `GIBaseInfo` is abstract, but despite that, changing the name so it sits inside the `GIBaseInfo` class makes sense. There is no `GIInfo` type. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2024-02-08 11:34:40 +01:00
return (GIFieldInfo *) gi_base_info_new (GI_INFO_TYPE_FIELD, (GIBaseInfo*)info, rinfo->typelib, offset);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_properties:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of properties that this object type has.
*
* Returns: number of properties
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_properties (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_properties;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_property:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of property to get
*
* Obtain an object type property at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.PropertyInfo]. Free the
* struct by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIPropertyInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_property (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ n * header->property_blob_size;
gibaseinfo: Rename gi_info_new() to gi_base_info_new() It’s actually a factory method rather than a constructor, since `GIBaseInfo` is abstract, but despite that, changing the name so it sits inside the `GIBaseInfo` class makes sense. There is no `GIInfo` type. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2024-02-08 11:34:40 +01:00
return (GIPropertyInfo *) gi_base_info_new (GI_INFO_TYPE_PROPERTY, (GIBaseInfo*)info,
rinfo->typelib, offset);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_methods:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of methods that this object type has.
*
* Returns: number of methods
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_methods (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_methods;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_method:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of method to get
*
* Obtain an object type method at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.FunctionInfo]. Free the
* struct by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIFunctionInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_method (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ blob->n_properties * header->property_blob_size
+ n * header->function_blob_size;
gibaseinfo: Rename gi_info_new() to gi_base_info_new() It’s actually a factory method rather than a constructor, since `GIBaseInfo` is abstract, but despite that, changing the name so it sits inside the `GIBaseInfo` class makes sense. There is no `GIInfo` type. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2024-02-08 11:34:40 +01:00
return (GIFunctionInfo *) gi_base_info_new (GI_INFO_TYPE_FUNCTION, (GIBaseInfo*)info,
rinfo->typelib, offset);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_find_method:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
[GIObjectInfo] Fix a typo and document a func
2010-06-12 16:14:22 +02:00
* @name: name of method to obtain
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain a method of the object type given a @name.
*
* `NULL` will be returned if there’s no method available with that name.
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full) (nullable): The [class@GIRepository.FunctionInfo],
* or `NULL` if no method could be found. Free the struct by calling
* [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIFunctionInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_find_method (GIObjectInfo *info,
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *name)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size +
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ blob->n_properties * header->property_blob_size;
girepository: Remove `_` prefix from private functions Now that libgirepository uses `GI_AVAILABLE_IN_*` macros, that’s what controls symbol visibility. The `_` prefixes are redundant, and out of keeping with the rest of GLib. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 16:23:31 +01:00
return gi_base_info_find_method ((GIBaseInfo*)info, offset, blob->n_methods, name);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_find_method_using_interfaces:
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
* @info: a #GIObjectInfo
* @name: name of method to obtain
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
* @declarer: (out) (transfer full) (optional) (nullable): The
* [class@GIRepository.ObjectInfo] or [class@GIRepository.InterfaceInfo] which
* declares the method, or `NULL` to ignore. If no method is found, this will
* return `NULL`.
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
*
* Obtain a method of the object given a @name, searching both the
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* object @info and any interfaces it implements.
*
* `NULL` will be returned if there’s no method available with that name.
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
*
* Note that this function does *not* search parent classes; you will have
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* to chain up if that’s desired.
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full) (nullable): The [class@GIRepository.FunctionInfo],
* or `NULL` if none was found. Free the struct by calling
* [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
*/
GIFunctionInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_find_method_using_interfaces (GIObjectInfo *info,
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *name,
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
GIBaseInfo **declarer)
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
{
GIFunctionInfo *result = NULL;
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
GIBaseInfo *declarer_result = NULL;
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
result = gi_object_info_find_method (info, name);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
if (result)
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
declarer_result = gi_base_info_ref (info);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
if (result == NULL)
{
int n_interfaces;
int i;
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
n_interfaces = gi_object_info_get_n_interfaces (info);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
for (i = 0; i < n_interfaces; ++i)
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
{
GIInterfaceInfo *iface_info;
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
iface_info = gi_object_info_get_interface (info, i);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
result = gi_interface_info_find_method (iface_info, name);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
if (result != NULL)
{
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
declarer_result = GI_BASE_INFO (g_steal_pointer (&iface_info));
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
break;
}
gi_base_info_unref ((GIBaseInfo*) iface_info);
}
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
}
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
if (declarer)
*declarer = g_steal_pointer (&declarer_result);
g_clear_pointer (&declarer_result, gi_base_info_unref);
return g_steal_pointer (&result);
g_object_info_find_method_using_interfaces: New function Pull this down into introspection from gjs; this will allow us to cache this better in the future (for example, by caching the infos for interfaces in the info for the object). https://bugzilla.gnome.org/show_bug.cgi?id=632924
2010-10-22 20:22:19 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_signals:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of signals that this object type has.
*
* Returns: number of signals
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_signals (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_signals;
}
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
static uint32_t
object_get_signal_offset (GIObjectInfo *info, unsigned int n)
{
GIRealInfo *rinfo = (GIRealInfo *) info;
Header *header = (Header *) rinfo->typelib->data;
ObjectBlob *blob = (ObjectBlob *) &rinfo->typelib->data[rinfo->offset];
return rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
+ blob->n_properties * header->property_blob_size
+ blob->n_methods * header->function_blob_size
+ n * header->signal_blob_size;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_signal:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of signal to get
*
* Obtain an object type signal at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.SignalInfo]. Free the
* struct by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GISignalInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_signal (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
return (GISignalInfo *) gi_base_info_new (GI_INFO_TYPE_SIGNAL, (GIBaseInfo*)info,
rinfo->typelib, object_get_signal_offset (info, n));
}
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
static GISignalInfo *
find_signal (GIRealInfo *rinfo,
uint32_t offset,
uint16_t n_signals,
const char *name)
{
Header *header = (Header *) rinfo->typelib->data;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
for (uint16_t i = 0; i < n_signals; i++)
{
const SignalBlob *sblob = (SignalBlob *) &rinfo->typelib->data[offset];
const char *sname = gi_typelib_get_string (rinfo->typelib, sblob->name);
if (strcmp (name, sname) == 0)
return (GISignalInfo *) gi_base_info_new (GI_INFO_TYPE_SIGNAL, (GIBaseInfo *) rinfo,
rinfo->typelib, offset);
offset += header->signal_blob_size;
}
return NULL;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_find_signal:
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
* @info: a #GIObjectInfo
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* @name: name of signal
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain a signal of the object type given a @name.
docs: fix up reference docs a bit - require GTK-Doc 1.19 - remove sgml mode - automatically generate gi.types (needs GTK-Doc 1.19) - fix https://bugzilla.gnome.org/show_bug.cgi?id=700025 [WIP] - rearange sections a bit [WIP] - add gi-building, gi-programming sections [WIP] - mark missing docs with TODO, which is only marginaly better than nothing but at least can be grepped :) https://bugzilla.gnome.org/show_bug.cgi?id=571648
2013-10-10 22:21:18 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* `NULL` will be returned if there’s no signal available with that name.
*
* Returns: (transfer full) (nullable): The [class@GIRepository.SignalInfo],
* or `NULL` if no signal could be found. Free the struct by calling
* [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
*/
GISignalInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_find_signal (GIObjectInfo *info,
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *name)
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
{
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
GIRealInfo *rinfo = (GIRealInfo *) info;
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
girepository: gi_object_info_find_signal(): Avoid repeated allocations Previously `gi_object_info_find_signal()` used `gi_object_info_get_signal()` to retrieve the *i*th signal and compare its name to the desired name. However, `gi_object_info_get_signal()` returns an allocated object. If the names were not matching, the allocated object was simply dropped, and this resulted in a lot of unnecessary allocations compared to the desired number of allocations, which is one. To avoid much of the overhead pertaining to the creation of these allocated `GISignalInfo` objects, introduce a new function that inspects the signal blobs directly and returns an allocated `GISignalInfo` object just for the matching signal. The function is largely a copy-and-paste of `gi_base_info_find_vfunc()`, which does the same thing, only for virtual functions. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/merge_requests/504
2024-11-04 18:33:16 +01:00
return find_signal (rinfo, object_get_signal_offset (info, 0),
gi_object_info_get_n_signals (info), name);
Add g_object_info_find_signal This matches g_object_info_find_method, and allows us to add indexing later. https://bugzilla.gnome.org/show_bug.cgi?id=633204
2010-10-26 17:47:00 +02:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_vfuncs:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of virtual functions that this object type has.
*
* Returns: number of virtual functions
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_vfuncs (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_vfuncs;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_vfunc:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of virtual function to get
*
* Obtain an object type virtual function at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.VFuncInfo]. Free the struct
* by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIVFuncInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_vfunc (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ blob->n_properties * header->property_blob_size
+ blob->n_methods * header->function_blob_size
+ blob->n_signals * header->signal_blob_size
+ n * header->vfunc_blob_size;
gibaseinfo: Rename gi_info_new() to gi_base_info_new() It’s actually a factory method rather than a constructor, since `GIBaseInfo` is abstract, but despite that, changing the name so it sits inside the `GIBaseInfo` class makes sense. There is no `GIInfo` type. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2024-02-08 11:34:40 +01:00
return (GIVFuncInfo *) gi_base_info_new (GI_INFO_TYPE_VFUNC, (GIBaseInfo*)info,
rinfo->typelib, offset);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_find_vfunc:
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
* @info: a #GIObjectInfo
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* @name: the name of a virtual function to find.
*
* Locate a virtual function slot with name @name.
*
* Note that the namespace for virtuals is distinct from that of methods; there
* may or may not be a concrete method associated for a virtual. If there is
* one, it may be retrieved using [method@GIRepository.VFuncInfo.get_invoker],
* otherwise that method will return `NULL`.
*
* See the documentation for [method@GIRepository.VFuncInfo.get_invoker] for
* more information on invoking virtuals.
*
* Returns: (transfer full) (nullable): The [class@GIRepository.VFuncInfo], or
* `NULL` if none is found. Free it with [method@GIRepository.BaseInfo.unref]
* when done.
* Since: 2.80
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
*/
GIVFuncInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_find_vfunc (GIObjectInfo *info,
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *name)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ blob->n_properties * header->property_blob_size
+ blob->n_methods * header->function_blob_size
+ blob->n_signals * header->signal_blob_size;
girepository: Remove `_` prefix from private functions Now that libgirepository uses `GI_AVAILABLE_IN_*` macros, that’s what controls symbol visibility. The `_` prefixes are redundant, and out of keeping with the rest of GLib. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 16:23:31 +01:00
return gi_base_info_find_vfunc (rinfo, offset, blob->n_vfuncs, name);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_find_vfunc_using_interfaces:
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
* @info: a #GIObjectInfo
giobjectinfo: Fix some documentation for find_vfunc_using_interfaces See #66
2012-04-10 00:09:10 +02:00
* @name: name of vfunc to obtain
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
* @declarer: (out) (transfer full) (optional) (nullable): The
* [class@GIRepository.ObjectInfo] or [class@GIRepository.InterfaceInfo] which
* declares the vfunc, or `NULL` to ignore. If no vfunc is found, this will
* return `NULL`.
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
*
* Locate a virtual function slot with name @name, searching both the object
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* @info and any interfaces it implements.
*
* `NULL` will be returned if there’s no vfunc available with that name.
*
* Note that the namespace for virtuals is distinct from that of methods; there
* may or may not be a concrete method associated for a virtual. If there is
* one, it may be retrieved using [method@GIRepository.VFuncInfo.get_invoker],
* otherwise that method will return `NULL`.
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
*
* Note that this function does *not* search parent classes; you will have
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* to chain up if that’s desired.
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full) (nullable): The [class@GIRepository.VFuncInfo],
* or `NULL` if none was found. Free the struct by calling
* [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
*/
GIVFuncInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_find_vfunc_using_interfaces (GIObjectInfo *info,
girepository: Use char instead of glib-specific gchar
2024-01-15 20:20:47 +01:00
const char *name,
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
GIBaseInfo **declarer)
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
{
GIVFuncInfo *result = NULL;
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
GIBaseInfo *declarer_result = NULL;
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
result = gi_object_info_find_vfunc (info, name);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
if (result)
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
declarer_result = gi_base_info_ref (info);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
if (result == NULL)
{
int n_interfaces;
int i;
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
n_interfaces = gi_object_info_get_n_interfaces (info);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
for (i = 0; i < n_interfaces; ++i)
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
{
GIInterfaceInfo *iface_info;
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
iface_info = gi_object_info_get_interface (info, i);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
result = gi_interface_info_find_vfunc (iface_info, name);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
if (result != NULL)
{
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
declarer_result = GI_BASE_INFO (g_steal_pointer (&iface_info));
girepository: Replace tabs with spaces in indentation We don't use tabs anywhere and the mixed setup just makes many editors to cry. So let's just replace the tabs with 8 spaces.
2024-01-16 17:30:37 +01:00
break;
}
gi_base_info_unref ((GIBaseInfo*) iface_info);
}
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
}
girepository: Fix declaration of ‘find using interfaces’ methods Fix the declaration and documentation of `gi_object_info_find_method_using_interfaces()` and `gi_object_info_find_vfunc_using_interfaces()`. The documentation was wrong when I wrote it: the value returned is the object or interface which declares the method or vfunc, not the one which implements it. The returned declarer info may be a `GIObjectInfo` or a `GIInterfaceInfo`. Since those two types have no subtype relation between them, the return type has to be changed to `GIBaseInfo`. Using `GIObjectInfo` would have been fine in girepository-1.0 because all `*Info` types were aliases of each other — but since the move to `GTypeInstance` this is no longer true. A unit test will be in the following commit. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Fixes: #3246
2024-02-05 19:40:03 +01:00
if (declarer)
*declarer = g_steal_pointer (&declarer_result);
g_clear_pointer (&declarer_result, gi_base_info_unref);
return g_steal_pointer (&result);
giobjectinfo: Add g_object_info_find_vfunc_using_interfaces As an analogue to g_object_info_find_method_using_interfaces, add a new API so that we can find a vfunc using the same strategy.
2012-01-04 20:46:51 +01:00
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_n_constants:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
*
* Obtain the number of constants that this object type has.
*
* Returns: number of constants
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_n_constants (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), 0);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
return blob->n_constants;
}
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_constant:
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
* @info: a #GIObjectInfo
* @n: index of constant to get
*
* Obtain an object type constant at index @n.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full): The [class@GIRepository.ConstantInfo]. Free the
* struct by calling [method@GIRepository.BaseInfo.unref] when done.
* Since: 2.80
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
*/
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIConstantInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_constant (GIObjectInfo *info,
girrepository: Use standard int sized types instead of g[u]int*
2024-01-15 22:20:02 +01:00
unsigned int n)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
girepository: Use size_t for size-related arguments and return types We used to use unsigned values, while they should be big enough to old the data we're handling here, it's cleaner and clearer if we use size_t as type for such values, as it makes straight forward to understand what a value should contain. It also makes these values more future proof.
2024-01-16 01:00:07 +01:00
size_t offset;
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
Header *header;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
girepository: Ensure indexed access on members is not overflowing Even though we expose member access as size_t, a GI info blob can typically just access to an a number of values that is never bigger than uint16_t, as that's how the typelib is defined (cfr. typelib internal header blob sizes and n_* elements). So let's avoid this to happen by adding a check.
2024-01-16 01:40:09 +01:00
g_return_val_if_fail (n <= G_MAXUINT16, NULL);
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
header = (Header *)rinfo->typelib->data;
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
girepository: Use constant time calculation for sections after Object fields Add "n_field_callbacks" to ObjectBlob which represents the number of object fields which are also callbacks. This a allows a constant time computation for accessing sections after fields. Track writing of this field by passing an extra argument through the girnode writers recursive call structure. This essentally reverts a portion of commit 7027bb256d0d1ab which added a linear time computation for accessing sections after fields. Update typelib validator to also ensure n_field_callbacks is properly set. https://bugzilla.gnome.org/show_bug.cgi?id=700338
2014-02-28 02:10:19 +01:00
offset = rinfo->offset + header->object_blob_size
+ (blob->n_interfaces + blob->n_interfaces % 2) * 2
+ blob->n_fields * header->field_blob_size
+ blob->n_field_callbacks * header->callback_blob_size
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
+ blob->n_properties * header->property_blob_size
+ blob->n_methods * header->function_blob_size
+ blob->n_signals * header->signal_blob_size
+ blob->n_vfuncs * header->vfunc_blob_size
+ n * header->constant_blob_size;
gibaseinfo: Rename gi_info_new() to gi_base_info_new() It’s actually a factory method rather than a constructor, since `GIBaseInfo` is abstract, but despite that, changing the name so it sits inside the `GIBaseInfo` class makes sense. There is no `GIInfo` type. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2024-02-08 11:34:40 +01:00
return (GIConstantInfo *) gi_base_info_new (GI_INFO_TYPE_CONSTANT, (GIBaseInfo*)info,
rinfo->typelib, offset);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_class_struct:
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Every [class@GObject.Object] has two structures; an instance structure and a
* class structure. This function returns the metadata for the class structure.
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (transfer full) (nullable): The [class@GIRepository.StructInfo] or
* `NULL` if it’s unknown. Free with [method@GIRepository.BaseInfo.unref] when
* done.
* Since: 2.80
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
*/
GIStructInfo *
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_class_struct (GIObjectInfo *info)
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
[GIObjectInfo] Document and check types
2010-06-12 01:51:32 +02:00
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
if (blob->gtype_struct)
girepository: Remove `_` prefix from private functions Now that libgirepository uses `GI_AVAILABLE_IN_*` macros, that’s what controls symbol visibility. The `_` prefixes are redundant, and out of keeping with the rest of GLib. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 16:23:31 +01:00
return (GIStructInfo *) gi_info_from_entry (rinfo->repository,
rinfo->typelib, blob->gtype_struct);
[girepository] Move the rest out of ginfo.ch
2010-06-07 00:52:12 +02:00
else
return NULL;
}
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
typedef const char* (*SymbolGetter) (GIObjectInfo *info);
static void *
_get_func(GIObjectInfo *info,
SymbolGetter getter)
{
const char* symbol;
GSList *parents = NULL, *l;
GIObjectInfo *parent_info;
girrepository: Use void* instead of gpointer
2024-01-15 20:16:00 +01:00
void *func = NULL;
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
girepository: Add various missing casts These aren’t needed at the moment, since all the `TypeInfo` structs in libgirepository are all aliases for each other. An upcoming commit will change that, however, so we need to be a little bit stricter about type safety in advance. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-28 18:14:30 +01:00
parent_info = (GIObjectInfo *) gi_base_info_ref ((GIBaseInfo *) info);
repository: Squash memory leak in _get_func and fix up style
2011-12-12 22:14:57 +01:00
while (parent_info != NULL)
{
parents = g_slist_prepend (parents, parent_info);
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
parent_info = gi_object_info_get_parent (parent_info);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
repository: Squash memory leak in _get_func and fix up style
2011-12-12 22:14:57 +01:00
for (l = parents; l; l = l->next)
{
parent_info = l->data;
symbol = getter (parent_info);
if (symbol == NULL)
continue;
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_typelib_symbol (((GIRealInfo *)parent_info)->typelib, symbol, (gpointer*) &func);
repository: Squash memory leak in _get_func and fix up style
2011-12-12 22:14:57 +01:00
if (func)
break;
}
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
g_slist_free_full (parents, (GDestroyNotify) gi_base_info_unref);
repository: Squash memory leak in _get_func and fix up style
2011-12-12 22:14:57 +01:00
return func;
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
/**
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
* gi_object_info_get_ref_function_name:
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain the symbol name of the function that should be called to ref this
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* object type.
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* It’s mainly used for fundamental types. The type signature for
* the symbol is [type@GIRepository.ObjectInfoRefFunction]. To fetch the
* function pointer see
* [method@GIRepository.ObjectInfo.get_ref_function_pointer].
*
* Returns: (nullable): the symbol, or `NULL` if the object type has no ref
* function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
const char *
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
gi_object_info_get_ref_function_name (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
if (blob->ref_func)
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->ref_func);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
return NULL;
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_ref_function_pointer: (skip)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain a pointer to a function which can be used to
* increase the reference count an instance of this object type.
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
*
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* This takes derivation into account and will reversely traverse
* the base classes of this type, starting at the top type.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (nullable): the function pointer, or `NULL` if the object type has
* no ref function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
GIObjectInfoRefFunction
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_ref_function_pointer (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
return (GIObjectInfoRefFunction)_get_func(info, (SymbolGetter)gi_object_info_get_ref_function_name);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
/**
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
* gi_object_info_get_unref_function_name:
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain the symbol name of the function that should be called to unref this
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* object type.
*
* It’s mainly used for fundamental types. The type signature for the symbol is
* [type@GIRepository.ObjectInfoUnrefFunction]. To fetch the function pointer
* see [method@GIRepository.ObjectInfo.get_unref_function_pointer].
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (nullable): the symbol, or `NULL` if the object type has no unref
* function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
const char *
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
gi_object_info_get_unref_function_name (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
if (blob->unref_func)
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->unref_func);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
return NULL;
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_unref_function_pointer: (skip)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain a pointer to a function which can be used to
* decrease the reference count an instance of this object type.
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
*
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* This takes derivation into account and will reversely traverse
* the base classes of this type, starting at the top type.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (nullable): the function pointer, or `NULL` if the object type has
* no unref function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
GIObjectInfoUnrefFunction
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_unref_function_pointer (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
return (GIObjectInfoUnrefFunction)_get_func(info, (SymbolGetter)gi_object_info_get_unref_function_name);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
/**
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
* gi_object_info_get_set_value_function_name:
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain the symbol name of the function that should be called to set a
* [type@GObject.Value], given an object instance pointer of this object type.
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* It’s mainly used for fundamental types. The type signature for the symbol
* is [type@GIRepository.ObjectInfoSetValueFunction]. To fetch the function
* pointer see [method@GIRepository.ObjectInfo.get_set_value_function_pointer].
*
* Returns: (nullable): the symbol, or `NULL` if the object type has no
* set-value function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
const char *
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
gi_object_info_get_set_value_function_name (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
if (blob->set_value_func)
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->set_value_func);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
return NULL;
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_set_value_function_pointer: (skip)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain a pointer to a function which can be used to set a
* [type@GObject.Value], given an instance of this object type.
*
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* This takes derivation into account and will reversely traverse
* the base classes of this type, starting at the top type.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (nullable): the function pointer, or `NULL` if the object type has
* no set-value function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
GIObjectInfoSetValueFunction
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_set_value_function_pointer (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
return (GIObjectInfoSetValueFunction)_get_func(info, (SymbolGetter)gi_object_info_get_set_value_function_name);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
/**
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
* gi_object_info_get_get_value_function_name:
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
* Obtain the symbol name of the function that should be called to convert
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* an object instance pointer of this object type to a [type@GObject.Value].
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* It’s mainly used for fundamental types. The type signature for the symbol
* is [type@GIRepository.ObjectInfoGetValueFunction]. To fetch the function
* pointer see [method@GIRepository.ObjectInfo.get_get_value_function_pointer].
*
* Returns: (nullable): the symbol, or `NULL` if the object type has no
* get-value function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
const char *
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
gi_object_info_get_get_value_function_name (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
GIRealInfo *rinfo = (GIRealInfo *)info;
ObjectBlob *blob;
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
blob = (ObjectBlob *)&rinfo->typelib->data[rinfo->offset];
if (blob->get_value_func)
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
return gi_typelib_get_string (rinfo->typelib, blob->get_value_func);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
return NULL;
}
/**
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
* gi_object_info_get_get_value_function_pointer: (skip)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* @info: a #GIObjectInfo
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Obtain a pointer to a function which can be used to extract an instance of
* this object type out of a [type@GObject.Value].
*
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
* This takes derivation into account and will reversely traverse
* the base classes of this type, starting at the top type.
*
giobjectinfo: Port documentation to gi-docgen and update Review and update the documentation, making sure it’s complete, formatted in gi-docgen format, and has all appropriate GIR annotations and `Since:` lines. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-13 14:23:44 +01:00
* Returns: (nullable): the function pointer, or `NULL` if the object type has
* no get-value function
* Since: 2.80
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
*/
GIObjectInfoGetValueFunction
girepository: Rename symbols to the GI namespace Rather than a mix of structs being in `GI` and their methods being in `g_`. We’ve chosen not to use the `g_` namespace because a number of the libgirepository class names are quite generic, so we’d end up with confusing symbols like `GScopeType` and `GArgument`. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-08 15:17:52 +01:00
gi_object_info_get_get_value_function_pointer (GIObjectInfo *info)
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
{
g_return_val_if_fail (info != NULL, NULL);
g_return_val_if_fail (GI_IS_OBJECT_INFO (info), NULL);
giobjectinfo: Rename get_*_function() methods to get_*_function_name() Because they return the function name, not a `GIFunctionInfo` or anything else. Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-12-12 19:07:50 +01:00
return (GIObjectInfoGetValueFunction)_get_func(info, (SymbolGetter)gi_object_info_get_get_value_function_name);
Add support for non-GObject fundamental objects This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
2010-06-12 23:08:56 +02:00
}
girepository: Port GIBaseInfo to GTypeInstance This adds more type safety to libgirepository, and allows differentiating the `GIBaseInfo` derived types using the type system. Two new derived types had to be added (previously they were just a collection of helper methods which worked directly on a `GIBaseInfo` and didn’t check types): `GICallbackInfo` and `GIUnresolvedInfo`. Further cleanups and refactoring might be needed on this, but the core of libgirepository now uses `GTypeInstance` and appears to still work (it’s difficult to be entirely sure because there are no unit tests yet). Signed-off-by: Philip Withnall <pwithnall@gnome.org> Helps: #3155
2023-11-28 18:24:20 +01:00
void
gi_object_info_class_init (gpointer g_class,
gpointer class_data)
{
GIBaseInfoClass *info_class = g_class;
info_class->info_type = GI_INFO_TYPE_OBJECT;
}
Reference in New Issue Copy Permalink