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
Sys_LogFile(bool enable)52 void Sys_LogFile( bool enable ){
53 	if ( enable && !g_hLogFile ) {
54 		// settings say we should be logging and we don't have a log file .. so create it
55 		if ( !SettingsPath_get()[0] ) {
56 			return; // cannot open a log file yet
57 		}
58 		// open a file to log the console (if user prefs say so)
59 		// the file handle is g_hLogFile
60 		// the log file is erased
61 		StringOutputStream name( 256 );
62 		name << SettingsPath_get() << "radiant.log";
63 		g_hLogFile = fopen( name.c_str(), "w" );
64 		if ( g_hLogFile != 0 ) {
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 NetRadiant '" 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 	}
76 	else if ( !enable && g_hLogFile != 0 ) {
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 
console_clear()88 void console_clear(){
89 	GtkTextBuffer* buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW( g_console ) );
90 	gtk_text_buffer_set_text( buffer, "", -1 );
91 }
92 
console_populate_popup(GtkTextView * textview,GtkMenu * menu,gpointer user_data)93 void console_populate_popup( GtkTextView* textview, GtkMenu* menu, gpointer user_data ){
94 	menu_separator( menu );
95 
96 	GtkWidget* item = gtk_menu_item_new_with_label( "Clear" );
97 	g_signal_connect( G_OBJECT( item ), "activate", G_CALLBACK( console_clear ), 0 );
98 	gtk_widget_show( item );
99 	container_add_widget( GTK_CONTAINER( menu ), item );
100 }
101 
destroy_set_null(GtkWindow * widget,GtkWidget ** p)102 gboolean destroy_set_null( GtkWindow* widget, GtkWidget** p ){
103 	*p = 0;
104 	return FALSE;
105 }
106 
107 WidgetFocusPrinter g_consoleWidgetFocusPrinter( "console" );
108 
Console_constructWindow(GtkWindow * toplevel)109 GtkWidget* Console_constructWindow( GtkWindow* toplevel ){
110 	GtkWidget* scr = gtk_scrolled_window_new( 0, 0 );
111 	gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW( scr ), GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
112 	gtk_scrolled_window_set_shadow_type( GTK_SCROLLED_WINDOW( scr ), GTK_SHADOW_IN );
113 	gtk_widget_show( scr );
114 
115 	{
116 		GtkWidget* text = gtk_text_view_new();
117 		gtk_widget_set_size_request( text, 0, -1 ); // allow shrinking
118 		gtk_text_view_set_wrap_mode( GTK_TEXT_VIEW( text ), GTK_WRAP_WORD );
119 		gtk_text_view_set_editable( GTK_TEXT_VIEW( text ), FALSE );
120 		gtk_container_add( GTK_CONTAINER( scr ), text );
121 		gtk_widget_show( text );
122 		g_console = text;
123 
124 		//globalExtendedASCIICharacterSet().print();
125 
126 		widget_connect_escape_clear_focus_widget( g_console );
127 
128 		//g_consoleWidgetFocusPrinter.connect(g_console);
129 
130 		g_signal_connect( G_OBJECT( g_console ), "populate-popup", G_CALLBACK( console_populate_popup ), 0 );
131 		g_signal_connect( G_OBJECT( g_console ), "destroy", G_CALLBACK( destroy_set_null ), &g_console );
132 	}
133 
134 	gtk_container_set_focus_chain( GTK_CONTAINER( scr ), NULL );
135 
136 	return scr;
137 }
138 
139 class GtkTextBufferOutputStream : public TextOutputStream
140 {
141 GtkTextBuffer* textBuffer;
142 GtkTextIter* iter;
143 GtkTextTag* tag;
144 public:
GtkTextBufferOutputStream(GtkTextBuffer * textBuffer,GtkTextIter * iter,GtkTextTag * tag)145 GtkTextBufferOutputStream( GtkTextBuffer* textBuffer, GtkTextIter* iter, GtkTextTag* tag ) : textBuffer( textBuffer ), iter( iter ), tag( tag ){
146 }
write(const char * buffer,std::size_t length)147 std::size_t write( const char* buffer, std::size_t length ){
148 	gtk_text_buffer_insert_with_tags( textBuffer, iter, buffer, gint( length ), tag, 0 );
149 	return length;
150 }
151 };
152 
Sys_Print(int level,const char * buf,std::size_t length)153 std::size_t Sys_Print( int level, const char* buf, std::size_t length ){
154 	bool contains_newline = std::find( buf, buf + length, '\n' ) != buf + length;
155 
156 	if ( level == SYS_ERR ) {
157 		Sys_LogFile( true );
158 	}
159 
160 	if ( g_hLogFile != 0 ) {
161 		fwrite( buf, 1, length, g_hLogFile );
162 		if ( contains_newline ) {
163 			fflush( g_hLogFile );
164 		}
165 	}
166 
167 	if ( level != SYS_NOCON ) {
168 		if ( g_console != 0 ) {
169 			GtkTextBuffer* buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW( g_console ) );
170 
171 			GtkTextIter iter;
172 			gtk_text_buffer_get_end_iter( buffer, &iter );
173 
174 			static GtkTextMark* end = gtk_text_buffer_create_mark( buffer, "end", &iter, FALSE );
175 
176 			const GdkColor yellow = { 0, 0xb0ff, 0xb0ff, 0x0000 };
177 			const GdkColor red = { 0, 0xffff, 0x0000, 0x0000 };
178 
179 			static GtkTextTag* error_tag = gtk_text_buffer_create_tag( buffer, "red_foreground", "foreground-gdk", &red, 0 );
180 			static GtkTextTag* warning_tag = gtk_text_buffer_create_tag( buffer, "yellow_foreground", "foreground-gdk", &yellow, 0 );
181 			static GtkTextTag* standard_tag = gtk_text_buffer_create_tag( buffer, "black_foreground", 0 );
182 			GtkTextTag* tag;
183 			switch ( level )
184 			{
185 			case SYS_WRN:
186 				tag = warning_tag;
187 				break;
188 			case SYS_ERR:
189 				tag = error_tag;
190 				break;
191 			case SYS_STD:
192 			case SYS_VRB:
193 			default:
194 				tag = standard_tag;
195 				break;
196 			}
197 
198 
199 			{
200 				GtkTextBufferOutputStream textBuffer( buffer, &iter, tag );
201 				if ( !globalCharacterSet().isUTF8() ) {
202 					BufferedTextOutputStream<GtkTextBufferOutputStream> buffered( textBuffer );
203 					buffered << StringRange( buf, buf + length );
204 				}
205 				else
206 				{
207 					textBuffer << StringRange( buf, buf + length );
208 				}
209 			}
210 
211 			// update console widget immediatly if we're doing something time-consuming
212 			if ( contains_newline ) {
213 				gtk_text_view_scroll_mark_onscreen( GTK_TEXT_VIEW( g_console ), end );
214 
215 				if ( !ScreenUpdates_Enabled() && GTK_WIDGET_REALIZED( g_console ) ) {
216 					ScreenUpdates_process();
217 				}
218 			}
219 		}
220 	}
221 	return length;
222 }
223 
224 
225 class SysPrintOutputStream : public TextOutputStream
226 {
227 public:
write(const char * buffer,std::size_t length)228 std::size_t write( const char* buffer, std::size_t length ){
229 	return Sys_Print( SYS_STD, buffer, length );
230 }
231 };
232 
233 class SysPrintErrorStream : public TextOutputStream
234 {
235 public:
write(const char * buffer,std::size_t length)236 std::size_t write( const char* buffer, std::size_t length ){
237 	return Sys_Print( SYS_ERR, buffer, length );
238 }
239 };
240 
241 SysPrintOutputStream g_outputStream;
242 
getSysPrintOutputStream()243 TextOutputStream& getSysPrintOutputStream(){
244 	return g_outputStream;
245 }
246 
247 SysPrintErrorStream g_errorStream;
248 
getSysPrintErrorStream()249 TextOutputStream& getSysPrintErrorStream(){
250 	return g_errorStream;
251 }
252