src/log.c

   1 /*
   2  *      log.c - this file is part of Geany, a fast and lightweight IDE
   3  *
   4  *      Copyright 2008-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
   5  *      Copyright 2008-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
   6  *
   7  *      This program is free software; you can redistribute it and/or modify
   8  *      it under the terms of the GNU General Public License as published by
   9  *      the Free Software Foundation; either version 2 of the License, or
  10  *      (at your option) any later version.
  11  *
  12  *      This program is distributed in the hope that it will be useful,
  13  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *      GNU General Public License for more details.
  16  *
  17  *      You should have received a copy of the GNU General Public License along
  18  *      with this program; if not, write to the Free Software Foundation, Inc.,
  19  *      51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 /*
  23  * Logging functions and the debug messages window.
  24  */
  25
  26 #include "geany.h"
  27
  28 #ifdef HAVE_LOCALE_H
  29 # include <locale.h>
  30 #endif
  31
  32 #include "log.h"
  33 #include "support.h"
  34 #include "utils.h"
  35 #include "ui_utils.h"
  36
  37
  38 static GString *log_buffer = NULL;
  39 static GtkTextBuffer *dialog_textbuffer = NULL;
  40
  41 enum
  42 {
  43         DIALOG_RESPONSE_CLEAR = 1
  44 };
  45
  46
  47 static void update_dialog(void)
  48 {
  49         if (dialog_textbuffer != NULL)
  50         {
  51                 GtkTextMark *mark;
  52                 GtkTextView *textview = g_object_get_data(G_OBJECT(dialog_textbuffer), "textview");
  53
  54                 gtk_text_buffer_set_text(dialog_textbuffer, log_buffer->str, log_buffer->len);
  55                 /* scroll to the end of the messages as this might be most interesting */
  56                 mark = gtk_text_buffer_get_insert(dialog_textbuffer);
  57                 gtk_text_view_scroll_to_mark(textview, mark, 0.0, FALSE, 0.0, 0.0);
  58         }
  59 }
  60
  61
  62 /* Geany's main debug/log function, declared in geany.h */
  63 void geany_debug(gchar const *format, ...)
  64 {
  65         va_list args;
  66         va_start(args, format);
  67         g_logv(G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format, args);
  68         va_end(args);
  69 }
  70
  71
  72 static void handler_print(const gchar *msg)
  73 {
  74         printf("%s\n", msg);
  75         if (G_LIKELY(log_buffer != NULL))
  76         {
  77                 g_string_append_printf(log_buffer, "%s\n", msg);
  78                 update_dialog();
  79         }
  80 }
  81
  82
  83 static void handler_printerr(const gchar *msg)
  84 {
  85         fprintf(stderr, "%s\n", msg);
  86         if (G_LIKELY(log_buffer != NULL))
  87         {
  88                 g_string_append_printf(log_buffer, "%s\n", msg);
  89                 update_dialog();
  90         }
  91 }
  92
  93
  94 static const gchar *get_log_prefix(GLogLevelFlags log_level)
  95 {
  96         switch (log_level & G_LOG_LEVEL_MASK)
  97         {
  98                 case G_LOG_LEVEL_ERROR:
  99                         return "ERROR\t\t";
 100                 case G_LOG_LEVEL_CRITICAL:
 101                         return "CRITICAL\t";
 102                 case G_LOG_LEVEL_WARNING:
 103                         return "WARNING\t";
 104                 case G_LOG_LEVEL_MESSAGE:
 105                         return "MESSAGE\t";
 106                 case G_LOG_LEVEL_INFO:
 107                         return "INFO\t\t";
 108                 case G_LOG_LEVEL_DEBUG:
 109                         return "DEBUG\t";
 110         }
 111         return "LOG";
 112 }
 113
 114
 115 static void handler_log(const gchar *domain, GLogLevelFlags level, const gchar *msg, gpointer data)
 116 {
 117         gchar *time_str;
 118
 119         if (G_LIKELY(app != NULL && app->debug_mode) ||
 120                 ! ((G_LOG_LEVEL_DEBUG | G_LOG_LEVEL_INFO | G_LOG_LEVEL_MESSAGE) & level))
 121         {
 122 #ifdef G_OS_WIN32
 123                 /* On Windows g_log_default_handler() is not enough, we need to print it
 124                  * explicitly on stderr for the console window */
 125                 /** TODO this can be removed if/when we remove the console window on Windows */
 126                 if (domain != NULL)
 127                         fprintf(stderr, "%s: %s\n", domain, msg);
 128                 else
 129                         fprintf(stderr, "%s\n", msg);
 130 #else
 131                 /* print the message as usual on stdout/stderr */
 132                 g_log_default_handler(domain, level, msg, data);
 133 #endif
 134         }
 135
 136         time_str = utils_get_current_time_string();
 137
 138         g_string_append_printf(log_buffer, "%s: %s %s: %s\n", time_str, domain,
 139                 get_log_prefix(level), msg);
 140
 141         g_free(time_str);
 142
 143         update_dialog();
 144 }
 145
 146
 147 void log_handlers_init(void)
 148 {
 149         log_buffer = g_string_sized_new(2048);
 150
 151         g_set_print_handler(handler_print);
 152         g_set_printerr_handler(handler_printerr);
 153         g_log_set_default_handler(handler_log, NULL);
 154 }
 155
 156
 157 static void on_dialog_response(GtkDialog *dialog, gint response, gpointer user_data)
 158 {
 159         if (response == DIALOG_RESPONSE_CLEAR)
 160         {
 161                 GtkTextIter start_iter, end_iter;
 162
 163                 gtk_text_buffer_get_start_iter(dialog_textbuffer, &start_iter);
 164                 gtk_text_buffer_get_end_iter(dialog_textbuffer, &end_iter);
 165                 gtk_text_buffer_delete(dialog_textbuffer, &start_iter, &end_iter);
 166
 167                 g_string_erase(log_buffer, 0, -1);
 168         }
 169         else
 170         {
 171                 gtk_widget_destroy(GTK_WIDGET(dialog));
 172                 dialog_textbuffer = NULL;
 173         }
 174 }
 175
 176
 177 void log_show_debug_messages_dialog(void)
 178 {
 179         GtkWidget *dialog, *textview, *vbox, *swin;
 180
 181         dialog = gtk_dialog_new_with_buttons(_("Debug Messages"), GTK_WINDOW(main_widgets.window),
 182                                 GTK_DIALOG_DESTROY_WITH_PARENT,
 183                                 _("Cl_ear"), DIALOG_RESPONSE_CLEAR,
 184                                 GTK_STOCK_CLOSE, GTK_RESPONSE_CLOSE, NULL);
 185         vbox = ui_dialog_vbox_new(GTK_DIALOG(dialog));
 186         gtk_box_set_spacing(GTK_BOX(vbox), 6);
 187         gtk_widget_set_name(dialog, "GeanyDialog");
 188
 189         gtk_window_set_default_size(GTK_WINDOW(dialog), 550, 300);
 190         gtk_dialog_set_default_response(GTK_DIALOG(dialog), GTK_RESPONSE_CLOSE);
 191
 192         textview = gtk_text_view_new();
 193         dialog_textbuffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(textview));
 194         g_object_set_data(G_OBJECT(dialog_textbuffer), "textview", textview);
 195         gtk_text_view_set_editable(GTK_TEXT_VIEW(textview), FALSE);
 196         gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(textview), FALSE);
 197         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(textview), GTK_WRAP_WORD_CHAR);
 198
 199         swin = gtk_scrolled_window_new(NULL, NULL);
 200         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(swin),
 201                 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 202         gtk_container_add(GTK_CONTAINER(swin), textview);
 203
 204         gtk_box_pack_start(GTK_BOX(vbox), swin, TRUE, TRUE, 0);
 205
 206         g_signal_connect(dialog, "response", G_CALLBACK(on_dialog_response), textview);
 207         gtk_widget_show_all(dialog);
 208
 209         update_dialog(); /* set text after showing the window, to not scroll an unrealized textview */
 210 }
 211
 212
 213 void log_finalize(void)
 214 {
 215         g_log_set_default_handler(g_log_default_handler, NULL);
 216
 217         g_string_free(log_buffer, TRUE);
 218         log_buffer = NULL;
 219 }