pidgin 2.14.14
Loading...
Searching...
No Matches
debug.h File Reference

Debug API. More...

#include <glib.h>
#include <stdarg.h>
Include dependency graph for debug.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  PurpleDebugUiOps
 Debug UI operations. More...

Enumerations

enum  PurpleDebugLevel {
  PURPLE_DEBUG_ALL = 0 , PURPLE_DEBUG_MISC , PURPLE_DEBUG_INFO , PURPLE_DEBUG_WARNING ,
  PURPLE_DEBUG_ERROR , PURPLE_DEBUG_FATAL
}
 Debug levels. More...

Functions

Debug API
void purple_debug (PurpleDebugLevel level, const char *category, const char *format,...) G_GNUC_PRINTF(3
 Outputs debug information.
void void purple_debug_misc (const char *category, const char *format,...) G_GNUC_PRINTF(2
 Outputs misc.
void void void purple_debug_info (const char *category, const char *format,...) G_GNUC_PRINTF(2
 Outputs info level debug information.
void void void void purple_debug_warning (const char *category, const char *format,...) G_GNUC_PRINTF(2
 Outputs warning level debug information.
void void void void void purple_debug_error (const char *category, const char *format,...) G_GNUC_PRINTF(2
 Outputs error level debug information.
void void void void void void purple_debug_fatal (const char *category, const char *format,...) G_GNUC_PRINTF(2
 Outputs fatal error level debug information.
void void void void void void void purple_debug_set_enabled (gboolean enabled)
 Enable or disable printing debug output to the console.
gboolean purple_debug_is_enabled (void)
 Check if console debug output is enabled.
void purple_debug_set_verbose (gboolean verbose)
 Enable or disable verbose debugging.
gboolean purple_debug_is_verbose (void)
 Check if verbose logging is enabled.
void purple_debug_set_unsafe (gboolean unsafe)
 Enable or disable unsafe debugging.
gboolean purple_debug_is_unsafe (void)
 Check if unsafe debugging is enabled.
UI Registration Functions
void purple_debug_set_ui_ops (PurpleDebugUiOps *ops)
 Sets the UI operations structure to be used when outputting debug information.
PurpleDebugUiOpspurple_debug_get_ui_ops (void)
 Returns the UI operations structure used when outputting debug information.
Debug Subsystem
void purple_debug_init (void)
 Initializes the debug subsystem.

Detailed Description

Debug API.

Definition in file debug.h.

Enumeration Type Documentation

◆ PurpleDebugLevel

Debug levels.

Enumerator
PURPLE_DEBUG_ALL 

All debug levels.

PURPLE_DEBUG_MISC 

General chatter.

PURPLE_DEBUG_INFO 

General operation Information.

PURPLE_DEBUG_WARNING 

Warnings.

PURPLE_DEBUG_ERROR 

Errors.

PURPLE_DEBUG_FATAL 

Fatal errors.

Definition at line 35 of file debug.h.

Function Documentation

◆ purple_debug()

void purple_debug ( PurpleDebugLevel level,
const char * category,
const char * format,
... )

Outputs debug information.

Parameters
levelThe debug level.
categoryThe category (or NULL).
formatThe format string.

◆ purple_debug_error()

void void void void void purple_debug_error ( const char * category,
const char * format,
... )

Outputs error level debug information.

This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as the level.

Parameters
categoryThe category (or NULL).
formatThe format string.
See also
purple_debug()

References purple_debug_error().

Referenced by purple_debug_error().

Here is the call graph for this function:

◆ purple_debug_fatal()

void void void void void void purple_debug_fatal ( const char * category,
const char * format,
... )

Outputs fatal error level debug information.

This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_ERROR as the level.

Parameters
categoryThe category (or NULL).
formatThe format string.
See also
purple_debug()

References purple_debug_fatal().

Referenced by purple_debug_fatal().

Here is the call graph for this function:

◆ purple_debug_get_ui_ops()

PurpleDebugUiOps * purple_debug_get_ui_ops ( void )

Returns the UI operations structure used when outputting debug information.

Returns
The UI operations structure in use.

References purple_debug_get_ui_ops().

Referenced by purple_debug_get_ui_ops().

Here is the call graph for this function:

◆ purple_debug_info()

void void void purple_debug_info ( const char * category,
const char * format,
... )

Outputs info level debug information.

This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_INFO as the level.

Parameters
categoryThe category (or NULL).
formatThe format string.
See also
purple_debug()

References purple_debug_info().

Referenced by purple_debug_info().

Here is the call graph for this function:

◆ purple_debug_is_enabled()

gboolean purple_debug_is_enabled ( void )

Check if console debug output is enabled.

Returns
TRUE if debugging is enabled, FALSE if it is not.

References purple_debug_is_enabled().

Referenced by purple_debug_is_enabled().

Here is the call graph for this function:

◆ purple_debug_is_unsafe()

gboolean purple_debug_is_unsafe ( void )

Check if unsafe debugging is enabled.

Defaults to FALSE.

Returns
TRUE if the debug logging of all messages is enabled, FALSE if messages that could potentially contain passwords and other sensitive information are not logged.
Since
2.6.0

References purple_debug_is_unsafe().

Referenced by purple_debug_is_unsafe().

Here is the call graph for this function:

◆ purple_debug_is_verbose()

gboolean purple_debug_is_verbose ( void )

Check if verbose logging is enabled.

Returns
TRUE if verbose debugging is enabled, FALSE if it is not.
Since
2.6.0

References purple_debug_is_verbose().

Referenced by purple_debug_is_verbose().

Here is the call graph for this function:

◆ purple_debug_misc()

void void purple_debug_misc ( const char * category,
const char * format,
... )

Outputs misc.

level debug information.

This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_MISC as the level.

Parameters
categoryThe category (or NULL).
formatThe format string.
See also
purple_debug()

References purple_debug_misc().

Referenced by purple_debug_misc().

Here is the call graph for this function:

◆ purple_debug_set_enabled()

void void void void void void void purple_debug_set_enabled ( gboolean enabled)

Enable or disable printing debug output to the console.

Parameters
enabledTRUE to enable debug output or FALSE to disable it.

References purple_debug_set_enabled().

Referenced by purple_debug_set_enabled().

Here is the call graph for this function:

◆ purple_debug_set_ui_ops()

void purple_debug_set_ui_ops ( PurpleDebugUiOps * ops)

Sets the UI operations structure to be used when outputting debug information.

Parameters
opsThe UI operations structure.

References purple_debug_set_ui_ops().

Referenced by purple_debug_set_ui_ops().

Here is the call graph for this function:

◆ purple_debug_set_unsafe()

void purple_debug_set_unsafe ( gboolean unsafe)

Enable or disable unsafe debugging.

This ordinarily should only be called by purple_debug_init, but there are cases where this can be useful for plugins.

Parameters
unsafeTRUE to enable debug logging of messages that could potentially contain passwords and other sensitive information. FALSE to disable it.
Since
2.6.0

References purple_debug_set_unsafe().

Referenced by purple_debug_set_unsafe().

Here is the call graph for this function:

◆ purple_debug_set_verbose()

void purple_debug_set_verbose ( gboolean verbose)

Enable or disable verbose debugging.

This ordinarily should only be called by purple_debug_init, but there are cases where this can be useful for plugins.

Parameters
verboseTRUE to enable verbose debugging or FALSE to disable it.
Since
2.6.0

References purple_debug_set_verbose().

Referenced by purple_debug_set_verbose().

Here is the call graph for this function:

◆ purple_debug_warning()

void void void void purple_debug_warning ( const char * category,
const char * format,
... )

Outputs warning level debug information.

This is a wrapper for purple_debug(), and uses PURPLE_DEBUG_WARNING as the level.

Parameters
categoryThe category (or NULL).
formatThe format string.
See also
purple_debug()

References purple_debug_warning().

Referenced by purple_debug_warning().

Here is the call graph for this function: