1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
* libMirage: debugging facilities
* Copyright (C) 2006-2014 Rok Mandeljc
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef __MIRAGE_DEBUG_H__
#define __MIRAGE_DEBUG_H__
/**
* SECTION: mirage-debug
* @title: Debug
* @short_description: Debugging facilities.
* @see_also: #MirageContext, #MirageContextual
* @include: mirage-debug.h
*
* libMirage supports changing of debug message verbosity on fly,
* without the need to restart the application. This is achieved by using
* #MirageContext objects, which are attached to objects implementing
* #MirageContextual interface. Such an object is #MirageObject, which
* can obtain context from its parent. This way, all objects in the
* hierarchy share the same context, and same debug verbosity setting.
*
* Debug verbosity can be controlled via mask, which can be set to the
* context using mirage_context_set_debug_mask(). See #MirageDebugMasks.
* The actual printing of debug messages within the code is achieved by
* mirage_contextual_debug_messagev() or mirage_contextual_debug_message(),
* or by convenience macro MIRAGE_DEBUG().
*/
/**
* MirageDebugMask:
* @MIRAGE_DEBUG_ERROR: error message
* @MIRAGE_DEBUG_WARNING: warning message
* @MIRAGE_DEBUG_PARSER: message belonging to image parser and file stream parser
* @MIRAGE_DEBUG_DISC: message belonging to disc
* @MIRAGE_DEBUG_SESSION: message belonging to session
* @MIRAGE_DEBUG_TRACK: message belonging to track
* @MIRAGE_DEBUG_SECTOR: message belonging to sector
* @MIRAGE_DEBUG_FRAGMENT: message belonging to fragment
* @MIRAGE_DEBUG_CDTEXT: message belonging to CD-TEXT encoder/decoder
* @MIRAGE_DEBUG_STREAM: messages belonging to file and filter stream I/O operations
* @MIRAGE_DEBUG_IMAGE_ID: messages belonging to image identification part of image parsers
* @MIRAGE_DEBUG_WRITER: messages belonging to image writer
*
* Debug message types and debug masks used to control verbosity of various
* parts of libMirage.
*
* All masks except %MIRAGE_DEBUG_ERROR and %MIRAGE_DEBUG_WARNING can be combined
* together to control verbosity of libMirage.
*/
typedef enum _MirageDebugMask
{
/* Debug types */
MIRAGE_DEBUG_ERROR = -1,
MIRAGE_DEBUG_WARNING = -2,
/* Debug masks */
MIRAGE_DEBUG_PARSER = 0x1,
MIRAGE_DEBUG_DISC = 0x2,
MIRAGE_DEBUG_SESSION = 0x4,
MIRAGE_DEBUG_TRACK = 0x8,
MIRAGE_DEBUG_SECTOR = 0x10,
MIRAGE_DEBUG_FRAGMENT = 0x20,
MIRAGE_DEBUG_CDTEXT = 0x40,
MIRAGE_DEBUG_STREAM = 0x80,
MIRAGE_DEBUG_IMAGE_ID = 0x100,
MIRAGE_DEBUG_WRITER = 0x200,
} MirageDebugMask;
/**
* MIRAGE_DEBUG:
* @obj: (in): object
* @lvl: (in): debug level
* @...: (in): debug message
*
* Debugging macro, provided for convenience. It performs cast to
* #MirageContextual interface on @obj and calls mirage_contextual_debug_message()
* with debug level @lvl and debug message, specified by format string and
* format arguments.
*/
#define MIRAGE_DEBUG(obj, lvl, ...) mirage_contextual_debug_message(MIRAGE_CONTEXTUAL(obj), lvl, __VA_ARGS__)
/**
* MIRAGE_DEBUG_ON:
* @obj: (in): object
* @lvl: (in): debug level
*
* Debugging macro, provided for convenience. It performs cast to
* #MirageContextual interface on @obj and calls mirage_contextual_debug_is_active()
* with debug level @lvl.
*/
#define MIRAGE_DEBUG_ON(obj, lvl) mirage_contextual_debug_is_active(MIRAGE_CONTEXTUAL(obj), lvl)
/**
* MIRAGE_DEBUG_PRINT_BUFFER:
* @obj: (in): object
* @lvl: (in): debug level
* @prefix: (in) (allow-none): prefix, or none
* @width: (in): output width
* @buffer: (in) (array length=buffer_length): buffer to print
* @buffer_length: (in): buffer length
*
* Debugging macro, provided for convenience. It performs cast to
* #MirageContextual interface on @obj and calls mirage_contextual_debug_print_buffer()
* with given arguments.
*/
#define MIRAGE_DEBUG_PRINT_BUFFER(obj, lvl, prefix, width, buffer, buffer_length) mirage_contextual_debug_print_buffer(MIRAGE_CONTEXTUAL(obj), lvl, prefix, width, buffer, buffer_length)
#endif /* __MIRAGE_DEBUG_H__ */
|
