gio/gdebugcontroller.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2021 Endless OS Foundation, LLC
   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  * SPDX-License-Identifier: LGPL-2.1-or-later
  21  */
  22
  23 #ifndef __G_DEBUG_CONTROLLER_H__
  24 #define __G_DEBUG_CONTROLLER_H__
  25
  26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  27 #error "Only <gio/gio.h> can be included directly."
  28 #endif
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 /**
  35  * G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME:
  36  *
  37  * Extension point for debug control functionality.
  38  * See [Extending GIO][extending-gio].
  39  *
  40  * Since: 2.72
  41  */
  42 #define G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME "gio-debug-controller"
  43
  44 /**
  45  * GDebugController:
  46  *
  47  * #GDebugController is an interface to expose control of debugging features and
  48  * debug output.
  49  *
  50  * Since: 2.72
  51  */
  52 #define G_TYPE_DEBUG_CONTROLLER             (g_debug_controller_get_type ())
  53 GIO_AVAILABLE_IN_2_72
  54 G_DECLARE_INTERFACE(GDebugController, g_debug_controller, g, debug_controller, GObject)
  55
  56 #define G_DEBUG_CONTROLLER(o)               (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DEBUG_CONTROLLER, GDebugController))
  57 #define G_IS_DEBUG_CONTROLLER(o)            (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DEBUG_CONTROLLER))
  58 #define G_DEBUG_CONTROLLER_GET_INTERFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), G_TYPE_DEBUG_CONTROLLER, GDebugControllerInterface))
  59
  60 /**
  61  * GDebugControllerInterface:
  62  * @g_iface: The parent interface.
  63  *
  64  * The virtual function table for #GDebugController.
  65  *
  66  * Since: 2.72
  67  */
  68 struct _GDebugControllerInterface {
  69   /*< private >*/
  70   GTypeInterface g_iface;
  71 };
  72
  73 GIO_AVAILABLE_IN_2_72
  74 gboolean               g_debug_controller_get_debug_enabled     (GDebugController *self);
  75 GIO_AVAILABLE_IN_2_72
  76 void                   g_debug_controller_set_debug_enabled     (GDebugController *self,
  77                                                                  gboolean          debug_enabled);
  78
  79 G_END_DECLS
  80
  81 #endif /* __G_DEBUG_CONTROLLER_H__ */