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 MemberCaller 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
68 #include "debugging/debugging.h"
72 #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 defined ( _DEBUG ) && defined ( WIN32 ) && defined ( _MSC_VER )
222 #if defined ( _DEBUG ) && defined ( WIN32 ) && defined ( _MSC_VER )
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::root.alert( 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::root.alert( 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 const char* home = environment_get_home_path();
332 StringOutputStream path( 256 );
334 g_strSettingsPath = path.c_str();
337 Q_mkdir( g_strSettingsPath.c_str() );
339 g_strAppPath = environment_get_app_path();
341 // radiant is installed in the parent dir of "tools/"
342 // NOTE: this is not very easy for debugging
343 // maybe add options to lookup in several places?
344 // (for now I had to create symlinks)
346 StringOutputStream path( 256 );
347 path << g_strAppPath.c_str() << "bitmaps/";
348 BitmapsPath_set( path.c_str() );
351 // we will set this right after the game selection is done
352 g_strGameToolsPath = g_strAppPath;
355 bool check_version_file( const char* filename, const char* version ){
356 TextFileInputStream file( filename );
357 if ( !file.failed() ) {
359 buf[file.read( buf, 9 )] = '\0';
361 // chomp it (the hard way)
363 while ( buf[chomp] >= '0' && buf[chomp] <= '9' )
367 return string_equal( buf, version );
372 bool check_version(){
373 // a safe check to avoid people running broken installations
374 // (otherwise, they run it, crash it, and blame us for not forcing them hard enough to pay attention while installing)
375 // make something idiot proof and someone will make better idiots, this may be overkill
376 // let's leave it disabled in debug mode in any case
377 // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=431
379 #define CHECK_VERSION
382 // locate and open RADIANT_MAJOR and RADIANT_MINOR
383 bool bVerIsGood = true;
385 StringOutputStream ver_file_name( 256 );
386 ver_file_name << AppPath_get() << "RADIANT_MAJOR";
387 bVerIsGood = check_version_file( ver_file_name.c_str(), RADIANT_MAJOR_VERSION );
390 StringOutputStream ver_file_name( 256 );
391 ver_file_name << AppPath_get() << "RADIANT_MINOR";
392 bVerIsGood = check_version_file( ver_file_name.c_str(), RADIANT_MINOR_VERSION );
396 StringOutputStream msg( 256 );
397 msg << "This editor binary (" RADIANT_VERSION ") doesn't match what the latest setup has configured in this directory\n"
398 "Make sure you run the right/latest editor binary you installed\n"
400 ui::alert( 0, msg.c_str(), "Radiant", eMB_OK, eMB_ICONDEFAULT );
408 void create_global_pid(){
410 the global prefs loading / game selection dialog might fail for any reason we don't know about
411 we need to catch when it happens, to cleanup the stateful prefs which might be killing it
412 and to turn on console logging for lookup of the problem
413 this is the first part of the two step .pid system
414 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
416 StringOutputStream g_pidFile( 256 ); ///< the global .pid file (only for global part of the startup)
418 g_pidFile << SettingsPath_get() << "radiant.pid";
421 pid = fopen( g_pidFile.c_str(), "r" );
425 if ( remove( g_pidFile.c_str() ) == -1 ) {
426 StringOutputStream msg( 256 );
427 msg << "WARNING: Could not delete " << g_pidFile.c_str();
428 ui::root.alert( msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
431 // in debug, never prompt to clean registry, turn console logging auto after a failed start
432 #if !defined( _DEBUG )
433 StringOutputStream msg( 256 );
434 msg << "Radiant failed to start properly the last time it was run.\n"
435 "The failure may be related to current global preferences.\n"
436 "Do you want to reset global preferences to defaults?";
438 if ( ui::root.alert( msg.c_str(), "Radiant - Startup Failure", ui::alert_type::YESNO, ui::alert_icon::QUESTION ) == ui::alert_response::YES ) {
439 g_GamesDialog.Reset();
443 msg << "Logging console output to " << SettingsPath_get() << "radiant.log\nRefer to the log if Radiant fails to start again.";
445 ui::root.alert( msg.c_str(), "Radiant - Console Log", ui::alert_type::OK );
448 // set without saving, the class is not in a coherent state yet
449 // just do the value change and call to start logging, CGamesDialog will pickup when relevant
450 g_GamesDialog.m_bForceLogConsole = true;
454 // create a primary .pid for global init run
455 pid = fopen( g_pidFile.c_str(), "w" );
461 void remove_global_pid(){
462 StringOutputStream g_pidFile( 256 );
463 g_pidFile << SettingsPath_get() << "radiant.pid";
466 if ( remove( g_pidFile.c_str() ) == -1 ) {
467 StringOutputStream msg( 256 );
468 msg << "WARNING: Could not delete " << g_pidFile.c_str();
469 ui::root.alert( msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
474 now the secondary game dependant .pid file
475 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
477 void create_local_pid(){
478 StringOutputStream g_pidGameFile( 256 ); ///< the game-specific .pid file
479 g_pidGameFile << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << "/radiant-game.pid";
481 FILE *pid = fopen( g_pidGameFile.c_str(), "r" );
484 if ( remove( g_pidGameFile.c_str() ) == -1 ) {
485 StringOutputStream msg;
486 msg << "WARNING: Could not delete " << g_pidGameFile.c_str();
487 ui::root.alert( msg.c_str(), "Radiant", ui::alert_type::OK, ui::alert_icon::Error );
490 // in debug, never prompt to clean registry, turn console logging auto after a failed start
491 #if !defined( _DEBUG )
492 StringOutputStream msg;
493 msg << "Radiant failed to start properly the last time it was run.\n"
494 "The failure may be caused by current preferences.\n"
495 "Do you want to reset all preferences to defaults?";
497 if ( ui::root.alert( msg.c_str(), "Radiant - Startup Failure", ui::alert_type::YESNO, ui::alert_icon::QUESTION ) == ui::alert_response::YES ) {
502 msg << "Logging console output to " << SettingsPath_get() << "radiant.log\nRefer to the log if Radiant fails to start again.";
504 ui::root.alert( msg.c_str(), "Radiant - Console Log", ui::alert_type::OK );
507 // force console logging on! (will go in prefs too)
508 g_GamesDialog.m_bForceLogConsole = true;
513 // create one, will remove right after entering message loop
514 pid = fopen( g_pidGameFile.c_str(), "w" );
523 now the secondary game dependant .pid file
524 http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
526 void remove_local_pid(){
527 StringOutputStream g_pidGameFile( 256 );
528 g_pidGameFile << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << "/radiant-game.pid";
529 remove( g_pidGameFile.c_str() );
532 void user_shortcuts_init(){
533 StringOutputStream path( 256 );
534 path << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << '/';
535 LoadCommandMap( path.c_str() );
536 SaveCommandMap( path.c_str() );
539 void user_shortcuts_save(){
540 StringOutputStream path( 256 );
541 path << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << '/';
542 SaveCommandMap( path.c_str() );
545 int main( int argc, char* argv[] ){
552 lib = LoadLibrary( "dwmapi.dll" );
554 void ( WINAPI *qDwmEnableComposition )( bool bEnable ) = ( void (WINAPI *) ( bool bEnable ) )GetProcAddress( lib, "DwmEnableComposition" );
555 if ( qDwmEnableComposition ) {
556 qDwmEnableComposition( FALSE );
562 static GOptionEntry entries[] = {
565 GError *error = NULL;
566 const char* mapname = NULL;
568 gtk_disable_setlocale();
569 if ( !gtk_init_with_args( &argc, &argv, "<filename.map>", entries, NULL, &error) ) {
570 g_print( "%s\n", error->message );
574 // Gtk already removed parsed `--options`
576 if ( strlen( argv[1] ) > 1 ) {
577 if ( g_str_has_suffix( argv[1], ".map" ) ) {
578 if ( g_path_is_absolute( argv[1] ) ) {
582 mapname = g_build_filename( g_get_current_dir(), argv[1], NULL );
586 g_print( "bad file name, will not load: %s\n", argv[1] );
591 g_print ( "%s\n", "too many arguments" );
595 // redirect Gtk warnings to the console
596 g_log_set_handler( "Gdk", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
597 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
598 g_log_set_handler( "Gtk", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
599 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
600 g_log_set_handler( "GtkGLExt", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
601 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
602 g_log_set_handler( "GLib", (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
603 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
604 g_log_set_handler( 0, (GLogLevelFlags)( G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING |
605 G_LOG_LEVEL_MESSAGE | G_LOG_LEVEL_INFO | G_LOG_LEVEL_DEBUG | G_LOG_FLAG_FATAL | G_LOG_FLAG_RECURSION ), error_redirect, 0 );
607 GlobalDebugMessageHandler::instance().setHandler( GlobalPopupDebugMessageHandler::instance() );
609 environment_init( argc, argv );
613 if ( !check_version() ) {
621 GlobalPreferences_Init();
623 g_GamesDialog.Init();
625 g_strGameToolsPath = g_pGameDescription->mGameToolsPath;
629 g_Preferences.Init(); // must occur before create_local_pid() to allow preferences to be reset
633 // in a very particular post-.pid startup
634 // we may have the console turned on and want to keep it that way
635 // so we use a latching system
636 if ( g_GamesDialog.m_bForceLogConsole ) {
638 g_Console_enableLogging = true;
639 g_GamesDialog.m_bForceLogConsole = false;
643 Radiant_Initialise();
645 user_shortcuts_init();
648 g_pParentWnd = new MainFrame();
652 if ( mapname != NULL ) {
653 Map_LoadFile( mapname );
655 else if ( g_bLoadLastMap && !g_strLastMap.empty() ) {
656 Map_LoadFile( g_strLastMap.c_str() );
663 // load up shaders now that we have the map loaded
665 TextureBrowser_ShowStartupShaders( GlobalTextureBrowser() );
672 // avoid saving prefs when the app is minimized
673 if ( g_pParentWnd->IsSleeping() ) {
674 globalOutputStream() << "Shutdown while sleeping, not saving prefs\n";
675 g_preferences_globals.disable_ini = true;
680 if ( !Map_Unnamed( g_map ) ) {
681 g_strLastMap = Map_Name( g_map );
686 user_shortcuts_save();
690 // close the log file if any
691 Sys_LogFile( false );