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
22 /*! \mainpage GtkRadiant Documentation Index
24 \section intro_sec Introduction
26 This documentation is generated from comments in the source code.
28 \section links_sec Useful Links
30 \link include/itextstream.h include/itextstream.h \endlink - Global output and error message streams, similar to std::cout and std::cerr. \n
32 FileInputStream - similar to std::ifstream (binary mode) \n
33 FileOutputStream - similar to std::ofstream (binary mode) \n
34 TextFileInputStream - similar to std::ifstream (text mode) \n
35 TextFileOutputStream - similar to std::ofstream (text mode) \n
36 StringOutputStream - similar to std::stringstream \n
38 \link string/string.h string/string.h \endlink - C-style string comparison and memory management. \n
39 \link os/path.h os/path.h \endlink - Path manipulation for radiant's standard path format \n
40 \link os/file.h os/file.h \endlink - OS file-system access. \n
42 ::CopiedString - automatic string memory management \n
43 Array - automatic array memory management \n
44 HashTable - generic hashtable, similar to std::hash_map \n
46 \link math/vector.h math/vector.h \endlink - Vectors \n
47 \link math/matrix.h math/matrix.h \endlink - Matrices \n
48 \link math/quaternion.h math/quaternion.h \endlink - Quaternions \n
49 \link math/plane.h math/plane.h \endlink - Planes \n
50 \link math/aabb.h math/aabb.h \endlink - AABBs \n
52 Callback MemberCaller0 FunctionCaller - callbacks similar to using boost::function with boost::bind \n
53 SmartPointer SmartReference - smart-pointer and smart-reference similar to Loki's SmartPtr \n
55 \link generic/bitfield.h generic/bitfield.h \endlink - Type-safe bitfield \n
56 \link generic/enumeration.h generic/enumeration.h \endlink - Type-safe enumeration \n
58 DefaultAllocator - Memory allocation using new/delete, compliant with std::allocator interface \n
60 \link debugging/debugging.h debugging/debugging.h \endlink - Debugging macros \n
65 #include "globaldefs.h"
69 #include "debugging/debugging.h"
73 #include "uilib/uilib.h"
78 #include "stream/stringstream.h"
79 #include "stream/textfilestream.h"
81 #include "gtkutil/messagebox.h"
82 #include "gtkutil/image.h"
84 #include "texwindow.h"
86 #include "mainframe.h"
88 #include "preferences.h"
89 #include "environment.h"
90 #include "referencecache.h"
91 #include "stacktrace.h"
100 void error_redirect( const gchar *domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data ){
101 gboolean in_recursion;
105 in_recursion = ( log_level & G_LOG_FLAG_RECURSION ) != 0;
106 is_fatal = ( log_level & G_LOG_FLAG_FATAL ) != 0;
107 log_level = (GLogLevelFlags) ( log_level & G_LOG_LEVEL_MASK );
110 message = "(0) message";
114 strcpy( buf, domain );
123 case G_LOG_LEVEL_ERROR:
124 if ( in_recursion ) {
125 strcat( buf, "ERROR (recursed) **: " );
128 strcat( buf, "ERROR **: " );
131 case G_LOG_LEVEL_CRITICAL:
132 if ( in_recursion ) {
133 strcat( buf, "CRITICAL (recursed) **: " );
136 strcat( buf, "CRITICAL **: " );
139 case G_LOG_LEVEL_WARNING:
140 if ( in_recursion ) {
141 strcat( buf, "WARNING (recursed) **: " );
144 strcat( buf, "WARNING **: " );
147 case G_LOG_LEVEL_MESSAGE:
148 if ( in_recursion ) {
149 strcat( buf, "Message (recursed): " );
152 strcat( buf, "Message: " );
155 case G_LOG_LEVEL_INFO:
156 if ( in_recursion ) {
157 strcat( buf, "INFO (recursed): " );
160 strcat( buf, "INFO: " );
163 case G_LOG_LEVEL_DEBUG:
164 if ( in_recursion ) {
165 strcat( buf, "DEBUG (recursed): " );
168 strcat( buf, "DEBUG: " );
172 /* we are used for a log level that is not defined by GLib itself,
173 * try to make the best out of it.
175 if ( in_recursion ) {
176 strcat( buf, "LOG (recursed:" );
179 strcat( buf, "LOG (" );
182 gchar string[] = "0x00): ";
183 gchar *p = string + 2;
186 i = g_bit_nth_msf( log_level, -1 );
189 *p = '0' + ( i & 0xf );
194 strcat( buf, string );
197 strcat( buf, "): " );
201 strcat( buf, message );
203 strcat( buf, "\naborting...\n" );
210 globalErrorStream() << buf << "\n";
213 ERROR_MESSAGE( "GTK+ error: " << buf );
217 #if GDEF_COMPILER_MSVC && GDEF_DEBUG
222 #if GDEF_COMPILER_MSVC && GDEF_DEBUG
223 _CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
231 Lock() : m_locked( false ){
239 bool locked() const {
248 ScopedLock( Lock& lock ) : m_lock( lock ){
256 class LineLimitedTextOutputStream : public TextOutputStream
258 TextOutputStream& outputStream;
261 LineLimitedTextOutputStream( TextOutputStream& outputStream, std::size_t count )
262 : outputStream( outputStream ), count( count ){
264 std::size_t write( const char* buffer, std::size_t length ){
266 const char* p = buffer;
267 const char* end = buffer + length;
270 p = std::find( p, end, '\n' );
275 if ( --count == 0 ) {
280 outputStream.write( buffer, length );
286 class PopupDebugMessageHandler : public DebugMessageHandler
288 StringOutputStream m_buffer;
291 TextOutputStream& getOutputStream(){
292 if ( !m_lock.locked() ) {
295 return globalErrorStream();
297 bool handleMessage(){
298 getOutputStream() << "----------------\n";
299 LineLimitedTextOutputStream outputStream( getOutputStream(), 24 );
300 write_stack_trace( outputStream );
301 getOutputStream() << "----------------\n";
302 globalErrorStream() << m_buffer.c_str();
303 if ( !m_lock.locked() ) {
304 ScopedLock lock( m_lock );
306 m_buffer << "Break into the debugger?\n";
307 bool handled = ui::alert(ui::root, m_buffer.c_str(), "Radiant - Runtime Error", ui::alert_type::YESNO, ui::alert_icon::Error) == ui::alert_response::NO;
311 m_buffer << "Please report this error to the developers\n";
312 ui::alert(ui::root, m_buffer.c_str(), "Radiant - Runtime Error", ui::alert_type::OK, ui::alert_icon::Error);
320 typedef Static<PopupDebugMessageHandler> GlobalPopupDebugMessageHandler;
323 GlobalErrorStream::instance().setOutputStream( getSysPrintErrorStream() );
324 GlobalOutputStream::instance().setOutputStream( getSysPrintOutputStream() );
328 g_strSettingsPath = environment_get_home_path();
330 Q_mkdir( g_strSettingsPath.c_str() );
332 g_strAppPath = environment_get_app_path();
334 // radiant is installed in the parent dir of "tools/"
335 // NOTE: this is not very easy for debugging
336 // maybe add options to lookup in several places?
337 // (for now I had to create symlinks)
339 StringOutputStream path( 256 );
340 path << g_strAppPath.c_str() << "bitmaps/";
341 BitmapsPath_set( path.c_str() );
344 // we will set this right after the game selection is done
345 g_strGameToolsPath = g_strAppPath;
348 bool check_version_file( const char* filename, const char* version ){
349 TextFileInputStream file( filename );
350 if ( !file.failed() ) {
352 buf[file.read( buf, 9 )] = '\0';
354 // chomp it (the hard way)
356 while ( buf[chomp] >= '0' && buf[chomp] <= '9' )
360 return string_equal( buf, version );
365 void create_global_pid(){
367 the global prefs loading / game selection dialog might fail for any reason we don't know about
368 we need to catch when it happens, to cleanup the stateful prefs which might be killing it
369 and to turn on console logging for lookup of the problem
370 this is the first part of the two step .pid system
371 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
373 StringOutputStream g_pidFile( 256 ); ///< the global .pid file (only for global part of the startup)
375 g_pidFile << SettingsPath_get() << "radiant.pid";
378 pid = fopen( g_pidFile.c_str(), "r" );
382 if ( remove( g_pidFile.c_str() ) == -1 ) {
383 StringOutputStream msg( 256 );
384 msg << "WARNING: Could not delete " << g_pidFile.c_str();
385 ui::alert( ui::root, msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
388 // in debug, never prompt to clean registry, turn console logging auto after a failed start
390 StringOutputStream msg(256);
391 msg << "Radiant failed to start properly the last time it was run.\n"
392 "The failure may be related to current global preferences.\n"
393 "Do you want to reset global preferences to defaults?";
395 if (ui::alert(ui::root, msg.c_str(), "Radiant - Startup Failure", ui::alert_type::YESNO, ui::alert_icon::Question) == ui::alert_response::YES) {
396 g_GamesDialog.Reset();
400 msg << "Logging console output to " << SettingsPath_get()
401 << "radiant.log\nRefer to the log if Radiant fails to start again.";
403 ui::alert(ui::root, msg.c_str(), "Radiant - Console Log", ui::alert_type::OK);
406 // set without saving, the class is not in a coherent state yet
407 // just do the value change and call to start logging, CGamesDialog will pickup when relevant
408 g_GamesDialog.m_bForceLogConsole = true;
412 // create a primary .pid for global init run
413 pid = fopen( g_pidFile.c_str(), "w" );
419 void remove_global_pid(){
420 StringOutputStream g_pidFile( 256 );
421 g_pidFile << SettingsPath_get() << "radiant.pid";
424 if ( remove( g_pidFile.c_str() ) == -1 ) {
425 StringOutputStream msg( 256 );
426 msg << "WARNING: Could not delete " << g_pidFile.c_str();
427 ui::alert( ui::root, msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
432 now the secondary game dependant .pid file
433 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
435 void create_local_pid(){
436 StringOutputStream g_pidGameFile( 256 ); ///< the game-specific .pid file
437 g_pidGameFile << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << "/radiant-game.pid";
439 FILE *pid = fopen( g_pidGameFile.c_str(), "r" );
442 if ( remove( g_pidGameFile.c_str() ) == -1 ) {
443 StringOutputStream msg;
444 msg << "WARNING: Could not delete " << g_pidGameFile.c_str();
445 ui::alert( ui::root, msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
448 // in debug, never prompt to clean registry, turn console logging auto after a failed start
450 StringOutputStream msg;
451 msg << "Radiant failed to start properly the last time it was run.\n"
452 "The failure may be caused by current preferences.\n"
453 "Do you want to reset all preferences to defaults?";
455 if (ui::alert(ui::root, msg.c_str(), "Radiant - Startup Failure", ui::alert_type::YESNO, ui::alert_icon::Question) == ui::alert_response::YES) {
460 msg << "Logging console output to " << SettingsPath_get()
461 << "radiant.log\nRefer to the log if Radiant fails to start again.";
463 ui::alert(ui::root, msg.c_str(), "Radiant - Console Log", ui::alert_type::OK);
466 // force console logging on! (will go in prefs too)
467 g_GamesDialog.m_bForceLogConsole = true;
472 // create one, will remove right after entering message loop
473 pid = fopen( g_pidGameFile.c_str(), "w" );
482 now the secondary game dependant .pid file
483 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
485 void remove_local_pid(){
486 StringOutputStream g_pidGameFile( 256 );
487 g_pidGameFile << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << "/radiant-game.pid";
488 remove( g_pidGameFile.c_str() );
491 void user_shortcuts_init(){
492 StringOutputStream path( 256 );
493 path << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << '/';
494 LoadCommandMap( path.c_str() );
495 SaveCommandMap( path.c_str() );
498 void user_shortcuts_save(){
499 StringOutputStream path( 256 );
500 path << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << '/';
501 SaveCommandMap( path.c_str() );
504 int main( int argc, char* argv[] ){
511 lib = LoadLibrary( "dwmapi.dll" );
513 void ( WINAPI *qDwmEnableComposition )( bool bEnable ) = ( void (WINAPI *) ( bool bEnable ) )GetProcAddress( lib, "DwmEnableComposition" );
514 if ( qDwmEnableComposition ) {
515 qDwmEnableComposition( FALSE );
521 const char* mapname = NULL;
522 char const *error = NULL;
523 if ( !ui::init( &argc, &argv, "<filename.map>", &error) ) {
524 g_print( "%s\n", error );
528 // Gtk already removed parsed `--options`
530 if ( strlen( argv[1] ) > 1 ) {
531 if ( g_str_has_suffix( argv[1], ".map" ) ) {
532 if ( g_path_is_absolute( argv[1] ) ) {
536 mapname = g_build_filename( g_get_current_dir(), argv[1], NULL );
540 g_print( "bad file name, will not load: %s\n", argv[1] );
545 g_print ( "%s\n", "too many arguments" );
549 // redirect Gtk warnings to the console
550 g_log_set_handler( "Gdk", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
551 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
552 g_log_set_handler( "Gtk", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
553 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
554 g_log_set_handler( "GtkGLExt", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
555 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
556 g_log_set_handler( "GLib", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
557 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
558 g_log_set_handler( 0, (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
559 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
561 GlobalDebugMessageHandler::instance().setHandler( GlobalPopupDebugMessageHandler::instance() );
563 environment_init(argc, (char const **) argv);
571 GlobalPreferences_Init();
573 g_GamesDialog.Init();
575 g_strGameToolsPath = g_pGameDescription->mGameToolsPath;
579 g_Preferences.Init(); // must occur before create_local_pid() to allow preferences to be reset
583 // in a very particular post-.pid startup
584 // we may have the console turned on and want to keep it that way
585 // so we use a latching system
586 if ( g_GamesDialog.m_bForceLogConsole ) {
588 g_Console_enableLogging = true;
589 g_GamesDialog.m_bForceLogConsole = false;
593 Radiant_Initialise();
595 user_shortcuts_init();
598 g_pParentWnd = new MainFrame();
602 if ( mapname != NULL ) {
603 Map_LoadFile( mapname );
605 else if ( g_bLoadLastMap && !g_strLastMap.empty() ) {
606 Map_LoadFile( g_strLastMap.c_str() );
613 // load up shaders now that we have the map loaded
615 TextureBrowser_ShowStartupShaders( GlobalTextureBrowser() );
622 // avoid saving prefs when the app is minimized
623 if ( g_pParentWnd->IsSleeping() ) {
624 globalOutputStream() << "Shutdown while sleeping, not saving prefs\n";
625 g_preferences_globals.disable_ini = true;
630 if ( !Map_Unnamed( g_map ) ) {
631 g_strLastMap = Map_Name( g_map );
636 user_shortcuts_save();
640 // close the log file if any
641 Sys_LogFile( false );