Declare variables at start of blocks in place.c
[dana/openbox.git] / openbox / debug.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    debug.c for the Openbox window manager
4    Copyright (c) 2003-2007   Dana Jansens
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #include "debug.h"
20 #include "prompt.h"
21 #include "openbox.h"
22 #include "gettext.h"
23 #include "obt/paths.h"
24
25 #include <glib.h>
26 #include <stdlib.h>
27 #include <stdarg.h>
28 #include <stdio.h>
29 #include <errno.h>
30
31 #ifdef HAVE_UNISTD_H
32 #  include <unistd.h>
33 #endif
34
35 static gboolean  enabled_types[OB_DEBUG_TYPE_NUM] = {FALSE};
36 static FILE     *log_file = NULL;
37 static guint     rr_handler_id = 0;
38 static guint     obt_handler_id = 0;
39 static guint     ob_handler_id = 0;
40 static guint     ob_handler_prompt_id = 0;
41 static GList    *prompt_queue = NULL;
42 static gboolean  allow_prompts = TRUE;
43
44 static void log_handler(const gchar *log_domain, GLogLevelFlags log_level,
45                         const gchar *message, gpointer user_data);
46 static void prompt_handler(const gchar *log_domain, GLogLevelFlags log_level,
47                            const gchar *message, gpointer user_data);
48
49 void ob_debug_startup(void)
50 {
51     ObtPaths *p = obt_paths_new();
52     gchar *dir = g_build_filename(obt_paths_cache_home(p),
53                                   "openbox", NULL);
54
55     /* log messages to a log file!  fancy, no? */
56     if (!obt_paths_mkdir_path(dir, 0777))
57         g_message(_("Unable to make directory '%s': %s"),
58                   dir, g_strerror(errno));
59     else {
60         gchar *name = g_build_filename(obt_paths_cache_home(p),
61                                        "openbox", "openbox.log", NULL);
62         /* unlink it before opening to remove competition */
63         unlink(name);
64         log_file = fopen(name, "w");
65         g_free(name);
66     }
67
68     rr_handler_id =
69         g_log_set_handler("ObRender", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL |
70                           G_LOG_FLAG_RECURSION, log_handler, NULL);
71     obt_handler_id =
72         g_log_set_handler("Obt", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL |
73                           G_LOG_FLAG_RECURSION, log_handler, NULL);
74     ob_handler_id =
75         g_log_set_handler("Openbox", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL |
76                           G_LOG_FLAG_RECURSION, log_handler, NULL);
77     ob_handler_prompt_id =
78         g_log_set_handler("Openbox", G_LOG_LEVEL_MASK & ~G_LOG_LEVEL_DEBUG,
79                           prompt_handler, NULL);
80
81     obt_paths_unref(p);
82     g_free(dir);
83 }
84
85 void ob_debug_shutdown(void)
86 {
87     g_log_remove_handler("ObRender", rr_handler_id);
88     g_log_remove_handler("Obt", obt_handler_id);
89     g_log_remove_handler("Openbox", ob_handler_id);
90     g_log_remove_handler("Openbox", ob_handler_prompt_id);
91
92     if (log_file) {
93         fclose(log_file);
94         log_file = NULL;
95     }
96 }
97
98 void ob_debug_enable(ObDebugType type, gboolean enable)
99 {
100     g_assert(type < OB_DEBUG_TYPE_NUM);
101     enabled_types[type] = enable;
102 }
103
104 static inline void log_print(FILE *out, const gchar* log_domain,
105                              const gchar *level, const gchar *message)
106 {
107     fprintf(out, "%s", log_domain);
108     fprintf(out, "-");
109     fprintf(out, "%s", level);
110     fprintf(out, ": ");
111     fprintf(out, "%s", message);
112     fprintf(out, "\n");
113     fflush(out);
114 }
115
116 static void log_handler(const gchar *log_domain, GLogLevelFlags log_level,
117                         const gchar *message, gpointer data)
118 {
119     FILE *out;
120     const gchar *level;
121
122     switch (log_level & G_LOG_LEVEL_MASK) {
123     case G_LOG_LEVEL_DEBUG:    level = "Debug";    out = stdout; break;
124     case G_LOG_LEVEL_INFO:     level = "Info";     out = stdout; break;
125     case G_LOG_LEVEL_MESSAGE:  level = "Message";  out = stdout; break;
126     case G_LOG_LEVEL_WARNING:  level = "Warning";  out = stderr; break;
127     case G_LOG_LEVEL_CRITICAL: level = "Critical"; out = stderr; break;
128     case G_LOG_LEVEL_ERROR:    level = "Error";    out = stderr; break;
129     default:                   g_assert_not_reached(); /* invalid level.. */
130     }
131
132     log_print(out, log_domain, level, message);
133     if (log_file) log_print(log_file, log_domain, level, message);
134 }
135
136 static void prompt_handler(const gchar *log_domain, GLogLevelFlags log_level,
137                            const gchar *message, gpointer data)
138 {
139     if (ob_state() == OB_STATE_RUNNING && allow_prompts)
140         prompt_queue = g_list_prepend(prompt_queue, g_strdup(message));
141     else
142         log_handler(log_domain, log_level, message, data);
143 }
144
145 static inline void log_argv(ObDebugType type,
146                             const gchar *format, va_list args)
147 {
148     const gchar *prefix;
149     gchar *message;
150
151     g_assert(type < OB_DEBUG_TYPE_NUM);
152     if (!enabled_types[type]) return;
153
154     switch (type) {
155     case OB_DEBUG_FOCUS:    prefix = "(FOCUS) ";           break;
156     case OB_DEBUG_APP_BUGS: prefix = "(APPLICATION BUG) "; break;
157     case OB_DEBUG_SM:       prefix = "(SESSION) ";         break;
158     default:                prefix = NULL;                 break;
159     }
160
161     message = g_strdup_vprintf(format, args);
162     if (prefix) {
163         gchar *a = message;
164         message = g_strconcat(prefix, message, NULL);
165         g_free(a);
166     }
167
168     g_debug("%s", message);
169     g_free(message);
170 }
171
172 void ob_debug(const gchar *a, ...)
173 {
174     va_list vl;
175
176     va_start(vl, a);
177     log_argv(OB_DEBUG_NORMAL, a, vl);
178     va_end(vl);
179 }
180
181 void ob_debug_type(ObDebugType type, const gchar *a, ...)
182 {
183     va_list vl;
184
185     va_start(vl, a);
186     log_argv(type, a, vl);
187     va_end(vl);
188 }
189
190 void ob_debug_show_prompts(void)
191 {
192     if (prompt_queue) {
193         allow_prompts = FALSE; /* avoid recursive prompts */
194         while (prompt_queue) {
195             prompt_show_message(prompt_queue->data, "Openbox", _("Close"));
196             g_free(prompt_queue->data);
197             prompt_queue = g_list_delete_link(prompt_queue, prompt_queue);
198         }
199         allow_prompts = TRUE;
200     }
201 }