## egg-debug

egg-debug — Debugging functions

## Synopsis

    #define             egg_debug                           (...)
    #define             egg_warning                         (...)
    #define             egg_error                           (...)
    gboolean            egg_debug_init                      (gint *argc,
                                                             gchar ***argv);
    GOptionGroup *      egg_debug_get_option_group          (void);
    gboolean            egg_debug_is_verbose                (void);
    void                egg_debug_backtrace                 (void);
    void                egg_debug_set_log_filename          (const gchar *filename);
    void                egg_debug_real                      (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);
    void                egg_warning_real                    (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);
    void                egg_error_real                      (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);

## Description

This file contains functions that can be used for debugging.

## Details

### egg_debug()

    #define             egg_debug(...)

Non critical debugging

`...` : |

### egg_warning()

    #define             egg_warning(...)

Important debugging

`...` : |

### egg_error()

    #define             egg_error(...)

Critical debugging, with exit

`...` : |

### egg_debug_init ()

    gboolean            egg_debug_init                      (gint *argc,
                                                             gchar ***argv);

Parses command line arguments.

`argc` : | a pointer to the number of command line arguments.
`argv` : | a pointer to the array of command line arguments.
Returns : | `TRUE` if initialization succeeded, otherwise `FALSE`.

### egg_debug_get_option_group ()

    GOptionGroup *      egg_debug_get_option_group          (void);

Returns a GOptionGroup for the commandline arguments recognized by debugging. You should add this group to your GOptionContext with `g_option_context_add_group()`, if you are using `g_option_context_parse()` to parse your commandline arguments.

Returns : | a GOptionGroup for the commandline arguments

### egg_debug_is_verbose ()

    gboolean            egg_debug_is_verbose                (void);

Returns : | TRUE if we have debugging enabled

### egg_debug_backtrace ()

    void                egg_debug_backtrace                 (void);

### egg_debug_set_log_filename ()

    void                egg_debug_set_log_filename          (const gchar *filename);

`filename` : |

### egg_debug_real ()

    void                egg_debug_real                      (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);

`func` : |
`file` : |
`line` : |
`format` : |
`...` : |

### egg_warning_real ()

    void                egg_warning_real                    (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);

`func` : |
`file` : |
`line` : |
`format` : |
`...` : |

### egg_error_real ()

    void                egg_error_real                      (const gchar *func,
                                                             const gchar *file,
                                                             gint line,
                                                             const gchar *format,
                                                             ...);

`func` : |
`file` : |
`line` : |
`format` : |
`...` : |