debug.h File Reference

Debug API. More...

#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  GaimDebugUiOps
 Debug UI operations. More...

Enumerations

enum  GaimDebugLevel {
  GAIM_DEBUG_ALL = 0, GAIM_DEBUG_MISC, GAIM_DEBUG_INFO, GAIM_DEBUG_WARNING,
  GAIM_DEBUG_ERROR, GAIM_DEBUG_FATAL
}
 Debug levels. More...

Functions

Debug API
void gaim_debug_vargs (GaimDebugLevel level, const char *category, const char *format, va_list args)
 Outputs debug information.
void gaim_debug (GaimDebugLevel level, const char *category, const char *format,...)
 Outputs debug information.
void gaim_debug_misc (const char *category, const char *format,...)
 Outputs misc.
void gaim_debug_info (const char *category, const char *format,...)
 Outputs info level debug information.
void gaim_debug_warning (const char *category, const char *format,...)
 Outputs warning level debug information.
void gaim_debug_error (const char *category, const char *format,...)
 Outputs error level debug information.
void gaim_debug_fatal (const char *category, const char *format,...)
 Outputs fatal error level debug information.
UI Registration Functions
void gaim_debug_set_ui_ops (GaimDebugUiOps *ops)
 Sets the UI operations structure to be used when outputting debug information.
GaimDebugUiOpsgaim_debug_get_ui_ops (void)
 Returns the UI operations structure used when outputting debug information.


Detailed Description

Debug API.

gaim

Gaim is the legal property of its developers, whose names are too numerous to list here. Please refer to the COPYRIGHT file distributed with this source distribution.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


Enumeration Type Documentation

enum GaimDebugLevel

Debug levels.

Enumerator:
GAIM_DEBUG_ALL  All debug levels.
GAIM_DEBUG_MISC  General chatter.
GAIM_DEBUG_INFO  General operation Information.
GAIM_DEBUG_WARNING  Warnings.
GAIM_DEBUG_ERROR  Errors.
GAIM_DEBUG_FATAL  Fatal errors.


Function Documentation

void gaim_debug ( GaimDebugLevel  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 gaim_debug_error ( const char *  category,
const char *  format,
  ... 
)

Outputs error level debug information.

This is a wrapper for gaim_debug(), and uses GAIM_DEBUG_ERROR as the level.

Parameters:
category The category (or NULL).
format The format string.
See also:
gaim_debug()

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

Outputs fatal error level debug information.

This is a wrapper for gaim_debug(), and uses GAIM_DEBUG_ERROR as the level.

Parameters:
category The category (or NULL).
format The format string.
See also:
gaim_debug()

GaimDebugUiOps* gaim_debug_get_ui_ops ( void   ) 

Returns the UI operations structure used when outputting debug information.

Returns:
The UI operations structure in use.

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

Outputs info level debug information.

This is a wrapper for gaim_debug(), and uses GAIM_DEBUG_INFO as the level.

Parameters:
category The category (or NULL).
format The format string.
See also:
gaim_debug()

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

Outputs misc.

level debug information.

This is a wrapper for gaim_debug(), and uses GAIM_DEBUG_MISC as the level.

Parameters:
category The category (or NULL).
format The format string.
See also:
gaim_debug()

void gaim_debug_set_ui_ops ( GaimDebugUiOps ops  ) 

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

Parameters:
ops The UI operations structure.

void gaim_debug_vargs ( GaimDebugLevel  level,
const char *  category,
const char *  format,
va_list  args 
)

Outputs debug information.

This differs from gaim_debug() in that it takes a va_list.

Parameters:
level The debug level.
category The category (or NULL).
format The format string.
args The format parameters.
See also:
gaim_debug()

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

Outputs warning level debug information.

This is a wrapper for gaim_debug(), and uses GAIM_DEBUG_WARNING as the level.

Parameters:
category The category (or NULL).
format The format string.
See also:
gaim_debug()


Generated on Sun Feb 18 08:39:42 2007 for gaim by  doxygen 1.5.1