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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
/*
* gedit-debug.c
* This file is part of gedit
*
* Copyright (C) 1998, 1999 Alex Roberts, Evan Lawrence
* Copyright (C) 2000, 2001 Chema Celorio, Paolo Maggi
* Copyright (C) 2002 - 2005 Paolo Maggi
*
* 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, see <http://www.gnu.org/licenses/>.
*/
#include "gedit-debug.h"
#include <stdio.h>
#define ENABLE_PROFILING
#ifdef ENABLE_PROFILING
static GTimer *timer = NULL;
static gdouble last_time = 0.0;
#endif
static GeditDebugSection enabled_sections = GEDIT_NO_DEBUG;
#define DEBUG_IS_ENABLED(section) (enabled_sections & (section))
/**
* gedit_debug_init:
*
* Initializes the debugging subsystem of gedit.
*
* The function checks for the existence of certain environment variables to
* determine whether to enable output for a debug section. To enable output
* for a specific debug section, set an environment variable of the same name;
* e.g. to enable output for the %GEDIT_DEBUG_PLUGINS section, set a
* <code>GEDIT_DEBUG_PLUGINS</code> environment variable. To enable output
* for all debug sections, set the <code>GEDIT_DEBUG</code> environment
* variable.
*
* This function must be called before any of the other debug functions are
* called. It must only be called once.
*/
void
gedit_debug_init (void)
{
if (g_getenv ("GEDIT_DEBUG") != NULL)
{
/* enable all debugging */
enabled_sections = ~GEDIT_NO_DEBUG;
goto out;
}
if (g_getenv ("GEDIT_DEBUG_VIEW") != NULL)
{
enabled_sections |= GEDIT_DEBUG_VIEW;
}
if (g_getenv ("GEDIT_DEBUG_PREFS") != NULL)
{
enabled_sections |= GEDIT_DEBUG_PREFS;
}
if (g_getenv ("GEDIT_DEBUG_WINDOW") != NULL)
{
enabled_sections |= GEDIT_DEBUG_WINDOW;
}
if (g_getenv ("GEDIT_DEBUG_PANEL") != NULL)
{
enabled_sections |= GEDIT_DEBUG_PANEL;
}
if (g_getenv ("GEDIT_DEBUG_PLUGINS") != NULL)
{
enabled_sections |= GEDIT_DEBUG_PLUGINS;
}
if (g_getenv ("GEDIT_DEBUG_TAB") != NULL)
{
enabled_sections |= GEDIT_DEBUG_TAB;
}
if (g_getenv ("GEDIT_DEBUG_DOCUMENT") != NULL)
{
enabled_sections |= GEDIT_DEBUG_DOCUMENT;
}
if (g_getenv ("GEDIT_DEBUG_COMMANDS") != NULL)
{
enabled_sections |= GEDIT_DEBUG_COMMANDS;
}
if (g_getenv ("GEDIT_DEBUG_APP") != NULL)
{
enabled_sections |= GEDIT_DEBUG_APP;
}
if (g_getenv ("GEDIT_DEBUG_UTILS") != NULL)
{
enabled_sections |= GEDIT_DEBUG_UTILS;
}
out:
#ifdef ENABLE_PROFILING
if (enabled_sections != GEDIT_NO_DEBUG)
{
timer = g_timer_new ();
}
#endif
}
/**
* gedit_debug:
* @section: debug section.
* @file: file name.
* @line: line number.
* @function: name of the function that is calling gedit_debug().
*
* If @section is enabled, then logs the trace information @file, @line, and
* @function.
*/
void
gedit_debug (GeditDebugSection section,
const gchar *file,
gint line,
const gchar *function)
{
gedit_debug_message (section, file, line, function, "%s", "");
}
/**
* gedit_debug_message:
* @section: debug section.
* @file: file name.
* @line: line number.
* @function: name of the function that is calling gedit_debug_message().
* @format: A g_vprintf() format string.
* @...: The format string arguments.
*
* If @section is enabled, then logs the trace information @file, @line, and
* @function along with the message obtained by formatting @format with the
* given format string arguments.
*/
void
gedit_debug_message (GeditDebugSection section,
const gchar *file,
gint line,
const gchar *function,
const gchar *format,
...)
{
if (G_UNLIKELY (DEBUG_IS_ENABLED (section)))
{
va_list args;
gchar *msg;
#ifdef ENABLE_PROFILING
gdouble seconds;
g_return_if_fail (timer != NULL);
seconds = g_timer_elapsed (timer, NULL);
#endif
g_return_if_fail (format != NULL);
va_start (args, format);
msg = g_strdup_vprintf (format, args);
va_end (args);
#ifdef ENABLE_PROFILING
g_print ("[%f (%f)] %s:%d (%s) %s\n",
seconds,
seconds - last_time,
file,
line,
function,
msg);
last_time = seconds;
#else
g_print ("%s:%d (%s) %s\n", file, line, function, msg);
#endif
fflush (stdout);
g_free (msg);
}
}
/**
* gedit_debug_plugin_message:
* @file: file name.
* @line: line number.
* @function: name of the function that is calling gedit_debug_plugin_message().
* @message: a message.
*
* If the section %GEDIT_DEBUG_PLUGINS is enabled, then logs the trace
* information @file, @line, and @function along with @message.
*
* This function may be overridden by GObject Introspection language bindings
* to be more language-specific.
*
* <emphasis>Python</emphasis>
*
* A PyGObject override is provided that has the following signature:
* <informalexample>
* <programlisting>
* def debug_plugin_message(format_str, *format_args):
* #...
* </programlisting>
* </informalexample>
*
* It automatically supplies parameters @file, @line, and @function, and it
* formats <code>format_str</code> with the given format arguments. The syntax
* of the format string is the usual Python string formatting syntax described
* by <ulink url="http://docs.python.org/library/stdtypes.html#string-formatting">5.6.2. String Formatting Operations</ulink>.
*
* Since: 3.4
*/
void
gedit_debug_plugin_message (const gchar *file,
gint line,
const gchar *function,
const gchar *message)
{
gedit_debug_message (GEDIT_DEBUG_PLUGINS, file, line, function, "%s", message);
}
/* ex:set ts=8 noet: */
|
