mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-10-30 19:16:19 +01:00
2ca3c1da83
We are still using gtk-doc, but gtk-doc uses Markdown these days, not DocBook.
207 lines
5.7 KiB
C
207 lines
5.7 KiB
C
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
|
|
* GObject introspection: Property implementation
|
|
*
|
|
* Copyright (C) 2005 Matthias Clasen
|
|
* Copyright (C) 2008,2009 Red Hat, Inc.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <glib.h>
|
|
|
|
#include <girepository.h>
|
|
#include "girepository-private.h"
|
|
#include "gitypelib-internal.h"
|
|
|
|
/**
|
|
* SECTION:gipropertyinfo
|
|
* @title: GIPropertyInfo
|
|
* @short_description: Struct representing a property
|
|
*
|
|
* GIPropertyInfo represents a property in a #GObject.
|
|
*
|
|
* A property belongs to either a #GIObjectInfo or a #GIInterfaceInfo.
|
|
*/
|
|
|
|
/**
|
|
* g_property_info_get_flags:
|
|
* @info: a #GIPropertyInfo
|
|
*
|
|
* Obtain the flags for this property info. See #GParamFlags for
|
|
* more information about possible flag values.
|
|
*
|
|
* Returns: the flags
|
|
*/
|
|
GParamFlags
|
|
g_property_info_get_flags (GIPropertyInfo *info)
|
|
{
|
|
GParamFlags flags;
|
|
GIRealInfo *rinfo = (GIRealInfo *)info;
|
|
PropertyBlob *blob;
|
|
|
|
g_return_val_if_fail (info != NULL, 0);
|
|
g_return_val_if_fail (GI_IS_PROPERTY_INFO (info), 0);
|
|
|
|
blob = (PropertyBlob *)&rinfo->typelib->data[rinfo->offset];
|
|
|
|
flags = 0;
|
|
|
|
if (blob->readable)
|
|
flags = flags | G_PARAM_READABLE;
|
|
|
|
if (blob->writable)
|
|
flags = flags | G_PARAM_WRITABLE;
|
|
|
|
if (blob->construct)
|
|
flags = flags | G_PARAM_CONSTRUCT;
|
|
|
|
if (blob->construct_only)
|
|
flags = flags | G_PARAM_CONSTRUCT_ONLY;
|
|
|
|
return flags;
|
|
}
|
|
|
|
/**
|
|
* g_property_info_get_type:
|
|
* @info: a #GIPropertyInfo
|
|
*
|
|
* Obtain the type information for the property @info.
|
|
*
|
|
* Returns: (transfer full): the #GITypeInfo, free it with
|
|
* g_base_info_unref() when done.
|
|
*/
|
|
GITypeInfo *
|
|
g_property_info_get_type (GIPropertyInfo *info)
|
|
{
|
|
GIRealInfo *rinfo = (GIRealInfo *)info;
|
|
|
|
g_return_val_if_fail (info != NULL, NULL);
|
|
g_return_val_if_fail (GI_IS_PROPERTY_INFO (info), NULL);
|
|
|
|
return _g_type_info_new ((GIBaseInfo*)info,
|
|
rinfo->typelib,
|
|
rinfo->offset + G_STRUCT_OFFSET (PropertyBlob, type));
|
|
}
|
|
|
|
/**
|
|
* g_property_info_get_ownership_transfer:
|
|
* @info: a #GIPropertyInfo
|
|
*
|
|
* Obtain the ownership transfer for this property. See #GITransfer for more
|
|
* information about transfer values.
|
|
*
|
|
* Returns: the transfer
|
|
*/
|
|
GITransfer
|
|
g_property_info_get_ownership_transfer (GIPropertyInfo *info)
|
|
{
|
|
GIRealInfo *rinfo = (GIRealInfo *)info;
|
|
PropertyBlob *blob;
|
|
|
|
g_return_val_if_fail (info != NULL, -1);
|
|
g_return_val_if_fail (GI_IS_PROPERTY_INFO (info), -1);
|
|
|
|
blob = (PropertyBlob *)&rinfo->typelib->data[rinfo->offset];
|
|
|
|
if (blob->transfer_ownership)
|
|
return GI_TRANSFER_EVERYTHING;
|
|
else if (blob->transfer_container_ownership)
|
|
return GI_TRANSFER_CONTAINER;
|
|
else
|
|
return GI_TRANSFER_NOTHING;
|
|
}
|
|
|
|
/**
|
|
* g_property_info_get_setter:
|
|
* @info: a #GIPropertyInfo
|
|
*
|
|
* Obtains the setter function associated with this #GIPropertyInfo.
|
|
*
|
|
* The setter is only available for %G_PARAM_WRITABLE properties that
|
|
* are also not %G_PARAM_CONSTRUCT_ONLY.
|
|
*
|
|
* Returns: (transfer full) (nullable): the function info or %NULL if not set.
|
|
* Free it with g_base_info_unref() when done.
|
|
*/
|
|
GIFunctionInfo *
|
|
g_property_info_get_setter (GIPropertyInfo *info)
|
|
{
|
|
GIRealInfo *rinfo = (GIRealInfo *)info;
|
|
PropertyBlob *blob;
|
|
GIBaseInfo *container;
|
|
GIInfoType parent_type;
|
|
|
|
g_return_val_if_fail (info != NULL, NULL);
|
|
g_return_val_if_fail (GI_IS_PROPERTY_INFO (info), NULL);
|
|
|
|
blob = (PropertyBlob *)&rinfo->typelib->data[rinfo->offset];
|
|
if (!blob->writable || blob->construct_only)
|
|
return NULL;
|
|
|
|
if (blob->setter == ACCESSOR_SENTINEL)
|
|
return NULL;
|
|
|
|
container = rinfo->container;
|
|
parent_type = g_base_info_get_type (container);
|
|
if (parent_type == GI_INFO_TYPE_OBJECT)
|
|
return g_object_info_get_method ((GIObjectInfo *) container, blob->setter);
|
|
else if (parent_type == GI_INFO_TYPE_INTERFACE)
|
|
return g_interface_info_get_method ((GIInterfaceInfo *) container, blob->setter);
|
|
else
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* g_property_info_get_getter:
|
|
* @info: a #GIPropertyInfo
|
|
*
|
|
* Obtains the getter function associated with this #GIPropertyInfo.
|
|
*
|
|
* The setter is only available for %G_PARAM_READABLE properties.
|
|
*
|
|
* Returns: (transfer full) (nullable): the function info or %NULL if not set.
|
|
* Free it with g_base_info_unref() when done.
|
|
*/
|
|
GIFunctionInfo *
|
|
g_property_info_get_getter (GIPropertyInfo *info)
|
|
{
|
|
GIRealInfo *rinfo = (GIRealInfo *)info;
|
|
PropertyBlob *blob;
|
|
GIBaseInfo *container;
|
|
GIInfoType parent_type;
|
|
|
|
g_return_val_if_fail (info != NULL, NULL);
|
|
g_return_val_if_fail (GI_IS_PROPERTY_INFO (info), NULL);
|
|
|
|
blob = (PropertyBlob *)&rinfo->typelib->data[rinfo->offset];
|
|
if (!blob->readable)
|
|
return NULL;
|
|
|
|
if (blob->getter == ACCESSOR_SENTINEL)
|
|
return NULL;
|
|
|
|
container = rinfo->container;
|
|
parent_type = g_base_info_get_type (container);
|
|
if (parent_type == GI_INFO_TYPE_OBJECT)
|
|
return g_object_info_get_method ((GIObjectInfo *) container, blob->getter);
|
|
else if (parent_type == GI_INFO_TYPE_INTERFACE)
|
|
return g_interface_info_get_method ((GIInterfaceInfo *) container, blob->getter);
|
|
else
|
|
return NULL;
|
|
}
|