2 Copyright (C) 1999-2006 Id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
5 This file is part of GtkRadiant.
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.
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.
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
25 #include <uilib/uilib.h>
29 #include "gtkutil/accelerator.h"
30 #include "gtkutil/messagebox.h"
31 #include "gtkutil/container.h"
32 #include "gtkutil/menu.h"
33 #include "gtkutil/nonmodal.h"
34 #include "stream/stringstream.h"
39 #include "mainframe.h"
41 // handle to the console log file
47 bool g_Console_enableLogging = false;
49 struct Gtk_Idle_Print_Data {
53 bool contains_newline;
56 // called whenever we need to open/close/check the console log file
57 void Sys_EnableLogFile( bool enable ){
58 if ( enable && !g_hLogFile ) {
59 // settings say we should be logging and we don't have a log file .. so create it
60 if ( !SettingsPath_get()[0] ) {
61 return; // cannot open a log file yet
63 // open a file to log the console (if user prefs say so)
64 // the file handle is g_hLogFile
65 // the log file is erased
66 StringOutputStream name( 256 );
67 name << SettingsPath_get() << "radiant.log";
68 g_hLogFile = fopen( name.c_str(), "w" );
69 if ( g_hLogFile != 0 ) {
70 globalOutputStream() << "Started logging to " << name.c_str() << "\n";
73 globalOutputStream() << "Today is: " << ctime( &localtime )
74 << "This is " RADIANT_NAME " " RADIANT_VERSION " compiled " __DATE__ "\n" RADIANT_ABOUTMSG "\n";
77 ui::alert( ui::root, "Failed to create log file, check write permissions in " RADIANT_NAME " directory.\n",
78 "Console logging", ui::alert_type::OK, ui::alert_icon::Error );
81 else if ( !enable && g_hLogFile != 0 ) {
82 // settings say we should not be logging but still we have an active logfile .. close it
85 globalOutputStream() << "Closing log file at " << ctime( &localtime ) << "\n";
91 ui::TextView g_console{ui::null};
97 void console_populate_popup( ui::TextView textview, ui::Menu menu, gpointer user_data ){
98 menu_separator( menu );
100 ui::Widget item(ui::MenuItem( "Clear" ));
101 item.connect( "activate", G_CALLBACK( console_clear ), 0 );
106 gboolean destroy_set_null( ui::Window widget, ui::Widget* p ){
107 *p = ui::Widget{ui::null};
111 WidgetFocusPrinter g_consoleWidgetFocusPrinter( "console" );
113 ui::Widget Console_constructWindow( ui::Window toplevel ){
114 auto scr = ui::ScrolledWindow(ui::New);
115 scr.overflow(ui::Policy::AUTOMATIC, ui::Policy::AUTOMATIC);
116 gtk_scrolled_window_set_shadow_type( GTK_SCROLLED_WINDOW( scr ), GTK_SHADOW_IN );
120 auto text = ui::TextView(ui::New);
121 text.dimensions(0, -1); // allow shrinking
122 gtk_text_view_set_wrap_mode( text, GTK_WRAP_WORD );
123 gtk_text_view_set_editable( text, FALSE );
128 //globalExtendedASCIICharacterSet().print();
130 widget_connect_escape_clear_focus_widget( g_console );
132 //g_consoleWidgetFocusPrinter.connect(g_console);
134 g_console.connect( "populate-popup", G_CALLBACK( console_populate_popup ), 0 );
135 g_console.connect( "destroy", G_CALLBACK( destroy_set_null ), &g_console );
138 gtk_container_set_focus_chain( GTK_CONTAINER( scr ), NULL );
143 class GtkTextBufferOutputStream : public TextOutputStream
145 GtkTextBuffer* textBuffer;
149 GtkTextBufferOutputStream( GtkTextBuffer* textBuffer, GtkTextIter* iter, GtkTextTag* tag ) : textBuffer( textBuffer ), iter( iter ), tag( tag ){
151 std::size_t write( const char* buffer, std::size_t length ){
152 gtk_text_buffer_insert_with_tags( textBuffer, iter, buffer, gint( length ), tag, NULL );
157 // This function is meant to be used with gtk_idle_add. It will free its argument.
158 static gboolean Gtk_Idle_Print( gpointer data ){
159 Gtk_Idle_Print_Data *args = reinterpret_cast<Gtk_Idle_Print_Data *>(data);
162 auto buffer = gtk_text_view_get_buffer( g_console );
165 gtk_text_buffer_get_end_iter( buffer, &iter );
167 static auto end = gtk_text_buffer_create_mark( buffer, "end", &iter, FALSE );
169 const GdkColor yellow = { 0, 0xb0ff, 0xb0ff, 0x0000 };
170 const GdkColor red = { 0, 0xffff, 0x0000, 0x0000 };
172 static auto error_tag = gtk_text_buffer_create_tag( buffer, "red_foreground", "foreground-gdk", &red, NULL );
173 static auto warning_tag = gtk_text_buffer_create_tag( buffer, "yellow_foreground", "foreground-gdk", &yellow, NULL );
174 static auto standard_tag = gtk_text_buffer_create_tag( buffer, "black_foreground", NULL );
176 switch ( args->level )
192 GtkTextBufferOutputStream textBuffer( buffer, &iter, tag );
193 if ( !globalCharacterSet().isUTF8() ) {
194 BufferedTextOutputStream<GtkTextBufferOutputStream> buffered( textBuffer );
195 buffered << StringRange( args->buf, args->buf + args->length );
199 textBuffer << StringRange( args->buf, args->buf + args->length );
203 // update console widget immediatly if we're doing something time-consuming
204 if ( args->contains_newline ) {
205 gtk_text_view_scroll_mark_onscreen( g_console, end );
207 if ( !ScreenUpdates_Enabled() && gtk_widget_get_realized( g_console ) ) {
208 ScreenUpdates_process();
215 return FALSE; // call this once, not repeatedly
218 // Print logs to the in-game console and/or to the log file.
219 // This function is thread safe.
220 std::size_t Sys_Print( int level, const char* buf, std::size_t length ){
221 bool contains_newline = std::find( buf, buf + length, '\n' ) != buf + length;
223 if ( level == SYS_ERR ) {
224 Sys_EnableLogFile( true );
227 if ( g_hLogFile != 0 ) {
228 // prevent parallel write
229 static std::mutex log_file_mutex;
230 std::lock_guard<std::mutex> guard(log_file_mutex);
232 fwrite( buf, 1, length, g_hLogFile );
233 if ( contains_newline ) {
234 fflush( g_hLogFile );
238 if ( level != SYS_NOCON && g_console ) {
239 auto data = reinterpret_cast<Gtk_Idle_Print_Data *>( malloc( sizeof(struct Gtk_Idle_Print_Data) ) );
240 if (data != nullptr) {
241 *data = { level, g_strndup(buf, length), length, contains_newline };
242 gdk_threads_add_idle(Gtk_Idle_Print, (gpointer)data);
250 class SysPrintOutputStream : public TextOutputStream
253 std::size_t write( const char* buffer, std::size_t length ){
254 return Sys_Print( SYS_STD, buffer, length );
258 class SysPrintErrorStream : public TextOutputStream
261 std::size_t write( const char* buffer, std::size_t length ){
262 return Sys_Print( SYS_ERR, buffer, length );
266 SysPrintOutputStream g_outputStream;
268 TextOutputStream& getSysPrintOutputStream(){
269 return g_outputStream;
272 SysPrintErrorStream g_errorStream;
274 TextOutputStream& getSysPrintErrorStream(){
275 return g_errorStream;