/src/glib/gio/gdbusinterface.c

Source (jump to first uncovered line)
/* GDBus - GLib D-Bus Library
 *
 * Copyright (C) 2008-2010 Red Hat, Inc.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include "gdbusobject.h"
#include "gdbusinterface.h"

#include "glibintl.h"

/**
 * SECTION:gdbusinterface
 * @short_description: Base type for D-Bus interfaces
 * @include: gio/gio.h
 *
 * The #GDBusInterface type is the base type for D-Bus interfaces both
 * on the service side (see #GDBusInterfaceSkeleton) and client side
 * (see #GDBusProxy).
 */

typedef GDBusInterfaceIface GDBusInterfaceInterface;
G_DEFINE_INTERFACE (GDBusInterface, g_dbus_interface, G_TYPE_OBJECT)

static void
g_dbus_interface_default_init (GDBusInterfaceIface *iface)
{
}

/* ---------------------------------------------------------------------------------------------------- */

/**
 * g_dbus_interface_get_info:
 * @interface_: An exported D-Bus interface.
 *
 * Gets D-Bus introspection information for the D-Bus interface
 * implemented by @interface_.
 *
 * Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.
 *
 * Since: 2.30
 */
GDBusInterfaceInfo *
g_dbus_interface_get_info (GDBusInterface *interface_)
{
  g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
  return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_info (interface_);
}

/**
 * g_dbus_interface_get_object: (skip)
 * @interface_: An exported D-Bus interface
 *
 * Gets the #GDBusObject that @interface_ belongs to, if any.
 *
 * It is not safe to use the returned object if @interface_ or
 * the returned object is being used from other threads. See
 * g_dbus_interface_dup_object() for a thread-safe alternative.
 *
 * Returns: (nullable) (transfer none): A #GDBusObject or %NULL. The returned
 *     reference belongs to @interface_ and should not be freed.
 *
 * Since: 2.30
 */
GDBusObject *
g_dbus_interface_get_object (GDBusInterface *interface_)
{
  g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
  return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_object (interface_);
}

/**
 * g_dbus_interface_dup_object: (rename-to g_dbus_interface_get_object)
 * @interface_: An exported D-Bus interface.
 *
 * Gets the #GDBusObject that @interface_ belongs to, if any.
 *
 * Returns: (nullable) (transfer full): A #GDBusObject or %NULL. The returned
 * reference should be freed with g_object_unref().
 *
 * Since: 2.32
 */
GDBusObject *
g_dbus_interface_dup_object (GDBusInterface *interface_)
{
  GDBusObject *ret;
  g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
  if (G_LIKELY (G_DBUS_INTERFACE_GET_IFACE (interface_)->dup_object != NULL))
    {
      ret = G_DBUS_INTERFACE_GET_IFACE (interface_)->dup_object (interface_);
    }
  else
    {
      g_warning ("No dup_object() vfunc on type %s - using get_object() in a way that is not thread-safe.",
                 g_type_name_from_instance ((GTypeInstance *) interface_));
      ret = G_DBUS_INTERFACE_GET_IFACE (interface_)->get_object (interface_);
      if (ret != NULL)
        g_object_ref (ret);
    }
  return ret;
}

/**
 * g_dbus_interface_set_object:
 * @interface_: An exported D-Bus interface.
 * @object: (nullable): A #GDBusObject or %NULL.
 *
 * Sets the #GDBusObject for @interface_ to @object.
 *
 * Note that @interface_ will hold a weak reference to @object.
 *
 * Since: 2.30
 */
void
g_dbus_interface_set_object (GDBusInterface    *interface_,
                             GDBusObject       *object)
{
  g_return_if_fail (G_IS_DBUS_INTERFACE (interface_));
  g_return_if_fail (object == NULL || G_IS_DBUS_OBJECT (object));
  G_DBUS_INTERFACE_GET_IFACE (interface_)->set_object (interface_, object);
}

Line	Count	Source (jump to first uncovered line)
1		/* GDBus - GLib D-Bus Library
2		*
3		* Copyright (C) 2008-2010 Red Hat, Inc.
4		*
5		* SPDX-License-Identifier: LGPL-2.1-or-later
6		*
7		* This library is free software; you can redistribute it and/or
8		* modify it under the terms of the GNU Lesser General Public
9		* License as published by the Free Software Foundation; either
10		* version 2.1 of the License, or (at your option) any later version.
11		*
12		* This library is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15		* Lesser General Public License for more details.
16		*
17		* You should have received a copy of the GNU Lesser General
18		* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19		*
20		* Author: David Zeuthen <davidz@redhat.com>
21		*/
22
23		#include "config.h"
24
25		#include "gdbusobject.h"
26		#include "gdbusinterface.h"
27
28		#include "glibintl.h"
29
30		/**
31		* SECTION:gdbusinterface
32		* @short_description: Base type for D-Bus interfaces
33		* @include: gio/gio.h
34		*
35		* The #GDBusInterface type is the base type for D-Bus interfaces both
36		* on the service side (see #GDBusInterfaceSkeleton) and client side
37		* (see #GDBusProxy).
38		*/
39
40		typedef GDBusInterfaceIface GDBusInterfaceInterface;
41		G_DEFINE_INTERFACE (GDBusInterface, g_dbus_interface, G_TYPE_OBJECT)
42
43		static void
44		g_dbus_interface_default_init (GDBusInterfaceIface *iface)
45	0	{
46	0	}
47
48		/* ---------------------------------------------------------------------------------------------------- */
49
50		/**
51		* g_dbus_interface_get_info:
52		* @interface_: An exported D-Bus interface.
53		*
54		* Gets D-Bus introspection information for the D-Bus interface
55		* implemented by @interface_.
56		*
57		* Returns: (transfer none): A #GDBusInterfaceInfo. Do not free.
58		*
59		* Since: 2.30
60		*/
61		GDBusInterfaceInfo *
62		g_dbus_interface_get_info (GDBusInterface *interface_)
63	0	{
64	0	g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
65	0	return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_info (interface_);
66	0	}
67
68		/**
69		* g_dbus_interface_get_object: (skip)
70		* @interface_: An exported D-Bus interface
71		*
72		* Gets the #GDBusObject that @interface_ belongs to, if any.
73		*
74		* It is not safe to use the returned object if @interface_ or
75		* the returned object is being used from other threads. See
76		* g_dbus_interface_dup_object() for a thread-safe alternative.
77		*
78		* Returns: (nullable) (transfer none): A #GDBusObject or %NULL. The returned
79		* reference belongs to @interface_ and should not be freed.
80		*
81		* Since: 2.30
82		*/
83		GDBusObject *
84		g_dbus_interface_get_object (GDBusInterface *interface_)
85	0	{
86	0	g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
87	0	return G_DBUS_INTERFACE_GET_IFACE (interface_)->get_object (interface_);
88	0	}
89
90		/**
91		* g_dbus_interface_dup_object: (rename-to g_dbus_interface_get_object)
92		* @interface_: An exported D-Bus interface.
93		*
94		* Gets the #GDBusObject that @interface_ belongs to, if any.
95		*
96		* Returns: (nullable) (transfer full): A #GDBusObject or %NULL. The returned
97		* reference should be freed with g_object_unref().
98		*
99		* Since: 2.32
100		*/
101		GDBusObject *
102		g_dbus_interface_dup_object (GDBusInterface *interface_)
103	0	{
104	0	GDBusObject *ret;
105	0	g_return_val_if_fail (G_IS_DBUS_INTERFACE (interface_), NULL);
106	0	if (G_LIKELY (G_DBUS_INTERFACE_GET_IFACE (interface_)->dup_object != NULL))
107	0	{
108	0	ret = G_DBUS_INTERFACE_GET_IFACE (interface_)->dup_object (interface_);
109	0	}
110	0	else
111	0	{
112	0	g_warning ("No dup_object() vfunc on type %s - using get_object() in a way that is not thread-safe.",
113	0	g_type_name_from_instance ((GTypeInstance *) interface_));
114	0	ret = G_DBUS_INTERFACE_GET_IFACE (interface_)->get_object (interface_);
115	0	if (ret != NULL)
116	0	g_object_ref (ret);
117	0	}
118	0	return ret;
119	0	}
120
121		/**
122		* g_dbus_interface_set_object:
123		* @interface_: An exported D-Bus interface.
124		* @object: (nullable): A #GDBusObject or %NULL.
125		*
126		* Sets the #GDBusObject for @interface_ to @object.
127		*
128		* Note that @interface_ will hold a weak reference to @object.
129		*
130		* Since: 2.30
131		*/
132		void
133		g_dbus_interface_set_object (GDBusInterface *interface_,
134		GDBusObject *object)
135	0	{
136	0	g_return_if_fail (G_IS_DBUS_INTERFACE (interface_));
137	0	g_return_if_fail (object == NULL \|\| G_IS_DBUS_OBJECT (object));
138	0	G_DBUS_INTERFACE_GET_IFACE (interface_)->set_object (interface_, object);
139	0	}

Coverage Report

Created: 2025-06-13 06:55