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...
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.
UI Registration Functions
void	purple_debug_set_ui_ops (PurpleDebugUiOps *ops)
	Sets the UI operations structure to be used when outputting debug information.
PurpleDebugUiOps *	purple_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.
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...

---

Detailed Description

Debug API.

Definition in file debug.h.

---

Enumeration Type Documentation

enum 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

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

Outputs debug information. Parameters: level  The debug level. category  The category (or NULL). format  The format string.

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: category  The category (or NULL). format  The format string. See also: purple_debug()

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: category  The category (or NULL). format  The format string. See also: purple_debug()

PurpleDebugUiOps* purple_debug_get_ui_ops (  void   )

Returns the UI operations structure used when outputting debug information. Returns: The UI operations structure in use.

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: category  The category (or NULL). format  The format string. See also: purple_debug()

gboolean purple_debug_is_enabled (  void   )

Check if console debug output is enabled. Returns: TRUE if debuggin is enabled, FALSE if it is not.

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: category  The category (or NULL). format  The format string. See also: purple_debug()

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

Enable or disable printing debug output to the console. Parameters: enabled  TRUE to enable debug output or FALSE to disable it.

void purple_debug_set_ui_ops (  PurpleDebugUiOps *  ops  )

Sets the UI operations structure to be used when outputting debug information. Parameters: ops  The UI operations structure.

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: category  The category (or NULL). format  The format string. See also: purple_debug()