mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-09-19 08:46:14 +02:00
71ff617159
Move the contents to the struct docs. Signed-off-by: Philip Withnall <philip@tecnocode.co.uk> Helps: #3037
120 lines
3.9 KiB
C
120 lines
3.9 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
||
*
|
||
* Copyright © 2021 Endless OS Foundation, LLC
|
||
*
|
||
* 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/>.
|
||
*
|
||
* SPDX-License-Identifier: LGPL-2.1-or-later
|
||
*/
|
||
|
||
#include "config.h"
|
||
#include "glib.h"
|
||
#include "glibintl.h"
|
||
|
||
#include "gdebugcontroller.h"
|
||
#include "ginitable.h"
|
||
#include "giomodule-priv.h"
|
||
|
||
/**
|
||
* GDebugController:
|
||
*
|
||
* `GDebugController` is an interface to expose control of debugging features and
|
||
* debug output.
|
||
*
|
||
* It is implemented on Linux using [class@Gio.DebugControllerDBus], which
|
||
* exposes a D-Bus interface to allow authenticated peers to control debug
|
||
* features in this process.
|
||
*
|
||
* Whether debug output is enabled is exposed as
|
||
* [property@Gio.DebugController:debug-enabled]. This controls
|
||
* [func@GLib.log_set_debug_enabled] by default. Application code may
|
||
* connect to the [signal@GObject.Object::notify] signal for it
|
||
* to control other parts of its debug infrastructure as necessary.
|
||
*
|
||
* If your application or service is using the default GLib log writer function,
|
||
* creating one of the built-in implementations of `GDebugController` should be
|
||
* all that’s needed to dynamically enable or disable debug output.
|
||
*
|
||
* Since: 2.72
|
||
*/
|
||
|
||
G_DEFINE_INTERFACE_WITH_CODE (GDebugController, g_debug_controller, G_TYPE_OBJECT,
|
||
g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_INITABLE))
|
||
|
||
static void
|
||
g_debug_controller_default_init (GDebugControllerInterface *iface)
|
||
{
|
||
/**
|
||
* GDebugController:debug-enabled:
|
||
*
|
||
* %TRUE if debug output should be exposed (for example by forwarding it to
|
||
* the journal), %FALSE otherwise.
|
||
*
|
||
* Since: 2.72
|
||
*/
|
||
g_object_interface_install_property (iface,
|
||
g_param_spec_boolean ("debug-enabled",
|
||
"Debug Enabled",
|
||
"Whether to expose debug output",
|
||
FALSE,
|
||
G_PARAM_READWRITE |
|
||
G_PARAM_STATIC_STRINGS |
|
||
G_PARAM_EXPLICIT_NOTIFY));
|
||
}
|
||
|
||
/**
|
||
* g_debug_controller_get_debug_enabled:
|
||
* @self: a #GDebugController
|
||
*
|
||
* Get the value of #GDebugController:debug-enabled.
|
||
*
|
||
* Returns: %TRUE if debug output should be exposed, %FALSE otherwise
|
||
* Since: 2.72
|
||
*/
|
||
gboolean
|
||
g_debug_controller_get_debug_enabled (GDebugController *self)
|
||
{
|
||
gboolean enabled;
|
||
|
||
g_return_val_if_fail (G_IS_DEBUG_CONTROLLER (self), FALSE);
|
||
|
||
g_object_get (G_OBJECT (self),
|
||
"debug-enabled", &enabled,
|
||
NULL);
|
||
|
||
return enabled;
|
||
}
|
||
|
||
/**
|
||
* g_debug_controller_set_debug_enabled:
|
||
* @self: a #GDebugController
|
||
* @debug_enabled: %TRUE if debug output should be exposed, %FALSE otherwise
|
||
*
|
||
* Set the value of #GDebugController:debug-enabled.
|
||
*
|
||
* Since: 2.72
|
||
*/
|
||
void
|
||
g_debug_controller_set_debug_enabled (GDebugController *self,
|
||
gboolean debug_enabled)
|
||
{
|
||
g_return_if_fail (G_IS_DEBUG_CONTROLLER (self));
|
||
|
||
g_object_set (G_OBJECT (self),
|
||
"debug-enabled", debug_enabled,
|
||
NULL);
|
||
}
|