initial
[xonotic/netradiant.git] / radiant / console.cpp
1 /*
2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
4
5 This file is part of GtkRadiant.
6
7 GtkRadiant 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 GtkRadiant 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
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20 */
21
22 #include "console.h"
23
24 #include <time.h>
25 #include <gtk/gtktextbuffer.h>
26 #include <gtk/gtktextview.h>
27 #include <gtk/gtkmenuitem.h>
28 #include <gtk/gtkscrolledwindow.h>
29
30 #include "gtkutil/accelerator.h"
31 #include "gtkutil/messagebox.h"
32 #include "gtkutil/container.h"
33 #include "gtkutil/menu.h"
34 #include "gtkutil/nonmodal.h"
35 #include "stream/stringstream.h"
36 #include "convert.h"
37
38 #include "version.h"
39 #include "aboutmsg.h"
40 #include "gtkmisc.h"
41 #include "mainframe.h"
42
43 // handle to the console log file
44 namespace
45 {
46   FILE* g_hLogFile;
47 }
48
49 bool g_Console_enableLogging = false;
50
51 // called whenever we need to open/close/check the console log file
52 void Sys_LogFile(bool enable)
53 {
54   if (enable && !g_hLogFile)
55   {
56     // settings say we should be logging and we don't have a log file .. so create it
57     // open a file to log the console (if user prefs say so)
58     // the file handle is g_hLogFile
59     // the log file is erased
60     StringOutputStream name(256);
61     name << SettingsPath_get() << "radiant.log";
62     g_hLogFile = fopen( name.c_str(), "w" );
63     if (g_hLogFile != 0)
64     {
65       globalOutputStream() << "Started logging to " << name.c_str() << "\n";
66       time_t localtime;
67       time(&localtime);
68       globalOutputStream() << "Today is: " << ctime(&localtime)
69         << "This is GtkRadiant '" RADIANT_VERSION "' compiled " __DATE__ "\n" RADIANT_ABOUTMSG "\n";
70     }
71     else
72       gtk_MessageBox (0, "Failed to create log file, check write permissions in Radiant directory.\n",
73           "Console logging", eMB_OK, eMB_ICONERROR );
74   }
75   else if (!enable && g_hLogFile != 0)
76   {
77     // settings say we should not be logging but still we have an active logfile .. close it
78     time_t localtime;
79     time(&localtime);
80     globalOutputStream() << "Closing log file at " << ctime(&localtime) << "\n";
81     fclose( g_hLogFile );
82     g_hLogFile = 0;
83   }
84 }
85
86 GtkWidget* g_console = 0;
87
88 void console_clear()
89 {
90   GtkTextBuffer* buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(g_console));
91   gtk_text_buffer_set_text(buffer, "", -1);
92 }
93
94 void console_populate_popup(GtkTextView* textview, GtkMenu* menu, gpointer user_data)
95 {
96   menu_separator(menu);
97
98   GtkWidget* item = gtk_menu_item_new_with_label ("Clear");
99   g_signal_connect(G_OBJECT (item), "activate", G_CALLBACK(console_clear), 0);
100   gtk_widget_show (item);
101   container_add_widget(GTK_CONTAINER(menu), item);
102 }
103
104 gboolean destroy_set_null(GtkWindow* widget, GtkWidget** p)
105 {
106   *p = 0;
107   return FALSE;
108 }
109
110 WidgetFocusPrinter g_consoleWidgetFocusPrinter("console");
111
112 GtkWidget* Console_constructWindow(GtkWindow* toplevel)
113 {
114   GtkWidget* scr = gtk_scrolled_window_new (0, 0);
115   gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scr), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
116   gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scr), GTK_SHADOW_IN);
117   gtk_widget_show(scr);
118
119   {
120     GtkWidget* text = gtk_text_view_new();
121     gtk_widget_set_size_request(text, 0, -1); // allow shrinking
122     gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(text), GTK_WRAP_WORD);
123     gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
124     gtk_container_add(GTK_CONTAINER (scr), text);
125     gtk_widget_show(text);
126     g_console = text;
127
128     //globalExtendedASCIICharacterSet().print();
129
130     widget_connect_escape_clear_focus_widget(g_console);
131
132     //g_consoleWidgetFocusPrinter.connect(g_console);
133
134     g_signal_connect(G_OBJECT(g_console), "populate-popup", G_CALLBACK(console_populate_popup), 0);
135     g_signal_connect(G_OBJECT(g_console), "destroy", G_CALLBACK(destroy_set_null), &g_console);
136   }
137
138   gtk_container_set_focus_chain(GTK_CONTAINER(scr), NULL);
139
140   return scr;
141 }
142
143 class GtkTextBufferOutputStream : public TextOutputStream
144 {
145   GtkTextBuffer* textBuffer;
146   GtkTextIter* iter;
147   GtkTextTag* tag;
148 public:
149   GtkTextBufferOutputStream(GtkTextBuffer* textBuffer, GtkTextIter* iter, GtkTextTag* tag) : textBuffer(textBuffer), iter(iter), tag(tag)
150   {
151   }
152   std::size_t write(const char* buffer, std::size_t length)
153   {
154     gtk_text_buffer_insert_with_tags(textBuffer, iter, buffer, gint(length), tag, 0);
155     return length;
156   }
157 };
158
159 std::size_t Sys_Print(int level, const char* buf, std::size_t length)
160 {
161   bool contains_newline = std::find(buf, buf+length, '\n') != buf+length;
162
163   if(level == SYS_ERR)
164   {
165     Sys_LogFile(true);
166   }
167
168   if (g_hLogFile != 0)
169   {
170     fwrite(buf, 1, length, g_hLogFile);
171     if(contains_newline)
172     {
173       fflush(g_hLogFile);
174     }
175   }
176
177   if (level != SYS_NOCON)
178   {
179     if (g_console != 0)
180     {
181       GtkTextBuffer* buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(g_console));
182       
183       GtkTextIter iter;
184       gtk_text_buffer_get_end_iter(buffer, &iter);
185
186       static GtkTextMark* end = gtk_text_buffer_create_mark(buffer, "end", &iter, FALSE);
187
188       const GdkColor yellow = { 0, 0xb0ff, 0xb0ff, 0x0000 };
189       const GdkColor red = { 0, 0xffff, 0x0000, 0x0000 };
190       const GdkColor black = { 0, 0x0000, 0x0000, 0x0000 };
191
192       static GtkTextTag* error_tag = gtk_text_buffer_create_tag (buffer, "red_foreground", "foreground-gdk", &red, 0);
193       static GtkTextTag* warning_tag = gtk_text_buffer_create_tag (buffer, "yellow_foreground", "foreground-gdk", &yellow, 0);
194       static GtkTextTag* standard_tag = gtk_text_buffer_create_tag (buffer, "black_foreground", "foreground-gdk", &black, 0);
195       GtkTextTag* tag;
196       switch (level)
197       {
198       case SYS_WRN:
199         tag = warning_tag;
200         break;
201       case SYS_ERR:
202         tag = error_tag;
203         break;
204       case SYS_STD:
205       case SYS_VRB:
206       default:
207         tag = standard_tag;
208         break;
209       }
210
211
212       {
213         GtkTextBufferOutputStream textBuffer(buffer, &iter, tag);
214         if(!globalCharacterSet().isUTF8())
215         {
216           BufferedTextOutputStream<GtkTextBufferOutputStream> buffered(textBuffer);
217           buffered << ConvertLocaleToUTF8(StringRange(buf, buf + length));
218         }
219         else
220         {
221           textBuffer << StringRange(buf, buf + length);
222         }
223       }
224
225       // update console widget immediatly if we're doing something time-consuming
226       if(contains_newline)
227       {
228         gtk_text_view_scroll_mark_onscreen(GTK_TEXT_VIEW(g_console), end);
229
230         if(!ScreenUpdates_Enabled() && GTK_WIDGET_REALIZED(g_console))
231         {
232           ScreenUpdates_process();
233         }
234       }
235     }
236   }
237   return length;
238 }
239
240
241 class SysPrintOutputStream : public TextOutputStream
242 {
243 public:
244   std::size_t write(const char* buffer, std::size_t length)
245   {
246     return Sys_Print(SYS_STD, buffer, length);
247   }
248 };
249
250 class SysPrintErrorStream : public TextOutputStream
251 {
252 public:
253   std::size_t write(const char* buffer, std::size_t length)
254   {
255     return Sys_Print(SYS_ERR, buffer, length);
256   }
257 };
258
259 SysPrintOutputStream g_outputStream;
260
261 TextOutputStream& getSysPrintOutputStream()
262 {
263   return g_outputStream;
264 }
265
266 SysPrintErrorStream g_errorStream;
267
268 TextOutputStream& getSysPrintErrorStream()
269 {
270   return g_errorStream;
271 }
272
273