mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-08 10:26:16 +01:00
0c8f7de55a
This is intended to provide a uniform interface for controlling whether the debug output from an application (or service) is emitted, typically to journald, but actually to wherever the application chooses to output it. The main implementation of `GDebugController` is `GDebugControllerDBus`, which is intended to be used on Linux. Other implementations may be added in future for other platforms, or larger applications may want to provide their own implementation which integrates with their ecosystem. The `GDebugControllerDBus` implementation exposes a D-Bus interface at `/org/gtk/Debugging` with a method to enable or disable debug output at runtime. This could be used by external harnesses, such as GNOME Builder or systemd, to give a uniform way to get debug output from an application. Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Fixes: #1190
83 lines
2.6 KiB
C
83 lines
2.6 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
|
*
|
|
* Copyright © 2021 Endless OS Foundation, LLC
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
#ifndef __G_DEBUG_CONTROLLER_H__
|
|
#define __G_DEBUG_CONTROLLER_H__
|
|
|
|
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
|
#error "Only <gio/gio.h> can be included directly."
|
|
#endif
|
|
|
|
#include <gio/giotypes.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME:
|
|
*
|
|
* Extension point for debug control functionality.
|
|
* See [Extending GIO][extending-gio].
|
|
*
|
|
* Since: 2.72
|
|
*/
|
|
#define G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME "gio-debug-controller"
|
|
|
|
/**
|
|
* GDebugController:
|
|
*
|
|
* #GDebugController is an interface to expose control of debugging features and
|
|
* debug output.
|
|
*
|
|
* Since: 2.72
|
|
*/
|
|
#define G_TYPE_DEBUG_CONTROLLER (g_debug_controller_get_type ())
|
|
GLIB_AVAILABLE_IN_2_72
|
|
G_DECLARE_INTERFACE(GDebugController, g_debug_controller, g, debug_controller, GObject)
|
|
|
|
#define G_DEBUG_CONTROLLER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DEBUG_CONTROLLER, GDebugController))
|
|
#define G_IS_DEBUG_CONTROLLER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DEBUG_CONTROLLER))
|
|
#define G_DEBUG_CONTROLLER_GET_INTERFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), G_TYPE_DEBUG_CONTROLLER, GDebugControllerInterface))
|
|
|
|
/**
|
|
* GDebugControllerInterface:
|
|
* @g_iface: The parent interface.
|
|
*
|
|
* The virtual function table for #GDebugController.
|
|
*
|
|
* Since: 2.72
|
|
*/
|
|
struct _GDebugControllerInterface {
|
|
/*< private >*/
|
|
GTypeInterface g_iface;
|
|
};
|
|
|
|
GLIB_AVAILABLE_IN_2_72
|
|
GDebugController *g_debug_controller_dup_default (void);
|
|
|
|
GLIB_AVAILABLE_IN_2_72
|
|
gboolean g_debug_controller_get_debug_enabled (GDebugController *self);
|
|
GLIB_AVAILABLE_IN_2_72
|
|
void g_debug_controller_set_debug_enabled (GDebugController *self,
|
|
gboolean debug_enabled);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_DEBUG_CONTROLLER_H__ */
|