]> de.git.xonotic.org Git - xonotic/netradiant.git/blob - radiant/main.cpp
cmake: drop generation and usage of radiant version files
[xonotic/netradiant.git] / radiant / main.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 /*! \mainpage GtkRadiant Documentation Index
23
24    \section intro_sec Introduction
25
26    This documentation is generated from comments in the source code.
27
28    \section links_sec Useful Links
29
30    \link include/itextstream.h include/itextstream.h \endlink - Global output and error message streams, similar to std::cout and std::cerr. \n
31
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
37
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
41
42    ::CopiedString - automatic string memory management \n
43    Array - automatic array memory management \n
44    HashTable - generic hashtable, similar to std::hash_map \n
45
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
51
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
54
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
57
58    DefaultAllocator - Memory allocation using new/delete, compliant with std::allocator interface \n
59
60    \link debugging/debugging.h debugging/debugging.h \endlink - Debugging macros \n
61
62  */
63
64 #include "main.h"
65 #include "globaldefs.h"
66
67 #include "version.h"
68
69 #include "debugging/debugging.h"
70
71 #include "iundo.h"
72
73 #include "uilib/uilib.h"
74
75 #include "cmdlib.h"
76 #include "os/file.h"
77 #include "os/path.h"
78 #include "stream/stringstream.h"
79 #include "stream/textfilestream.h"
80
81 #include "gtkutil/messagebox.h"
82 #include "gtkutil/image.h"
83 #include "console.h"
84 #include "texwindow.h"
85 #include "map.h"
86 #include "mainframe.h"
87 #include "commands.h"
88 #include "preferences.h"
89 #include "environment.h"
90 #include "referencecache.h"
91 #include "stacktrace.h"
92
93 #if GDEF_OS_WINDOWS
94 #include <windows.h>
95 #endif
96
97 void show_splash();
98 void hide_splash();
99
100 void error_redirect( const gchar *domain, GLogLevelFlags log_level, const gchar *message, gpointer user_data ){
101         gboolean in_recursion;
102         gboolean is_fatal;
103         char buf[256];
104
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 );
108
109         if ( !message ) {
110                 message = "(0) message";
111         }
112
113         if ( domain ) {
114                 strcpy( buf, domain );
115         }
116         else{
117                 strcpy( buf, "**" );
118         }
119         strcat( buf, "-" );
120
121         switch ( log_level )
122         {
123         case G_LOG_LEVEL_ERROR:
124                 if ( in_recursion ) {
125                         strcat( buf, "ERROR (recursed) **: " );
126                 }
127                 else{
128                         strcat( buf, "ERROR **: " );
129                 }
130                 break;
131         case G_LOG_LEVEL_CRITICAL:
132                 if ( in_recursion ) {
133                         strcat( buf, "CRITICAL (recursed) **: " );
134                 }
135                 else{
136                         strcat( buf, "CRITICAL **: " );
137                 }
138                 break;
139         case G_LOG_LEVEL_WARNING:
140                 if ( in_recursion ) {
141                         strcat( buf, "WARNING (recursed) **: " );
142                 }
143                 else{
144                         strcat( buf, "WARNING **: " );
145                 }
146                 break;
147         case G_LOG_LEVEL_MESSAGE:
148                 if ( in_recursion ) {
149                         strcat( buf, "Message (recursed): " );
150                 }
151                 else{
152                         strcat( buf, "Message: " );
153                 }
154                 break;
155         case G_LOG_LEVEL_INFO:
156                 if ( in_recursion ) {
157                         strcat( buf, "INFO (recursed): " );
158                 }
159                 else{
160                         strcat( buf, "INFO: " );
161                 }
162                 break;
163         case G_LOG_LEVEL_DEBUG:
164                 if ( in_recursion ) {
165                         strcat( buf, "DEBUG (recursed): " );
166                 }
167                 else{
168                         strcat( buf, "DEBUG: " );
169                 }
170                 break;
171         default:
172                 /* we are used for a log level that is not defined by GLib itself,
173                  * try to make the best out of it.
174                  */
175                 if ( in_recursion ) {
176                         strcat( buf, "LOG (recursed:" );
177                 }
178                 else{
179                         strcat( buf, "LOG (" );
180                 }
181                 if ( log_level ) {
182                         gchar string[] = "0x00): ";
183                         gchar *p = string + 2;
184                         guint i;
185
186                         i = g_bit_nth_msf( log_level, -1 );
187                         *p = i >> 4;
188                         p++;
189                         *p = '0' + ( i & 0xf );
190                         if ( *p > '9' ) {
191                                 *p += 'A' - '9' - 1;
192                         }
193
194                         strcat( buf, string );
195                 }
196                 else{
197                         strcat( buf, "): " );
198                 }
199         }
200
201         strcat( buf, message );
202         if ( is_fatal ) {
203                 strcat( buf, "\naborting...\n" );
204         }
205         else{
206                 strcat( buf, "\n" );
207         }
208
209         // spam it...
210         globalErrorStream() << buf << "\n";
211
212         if (is_fatal) {
213             ERROR_MESSAGE( "GTK+ error: " << buf );
214     }
215 }
216
217 #if GDEF_COMPILER_MSVC && GDEF_DEBUG
218 #include "crtdbg.h"
219 #endif
220
221 void crt_init(){
222 #if GDEF_COMPILER_MSVC && GDEF_DEBUG
223         _CrtSetDbgFlag( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );
224 #endif
225 }
226
227 class Lock
228 {
229 bool m_locked;
230 public:
231 Lock() : m_locked( false ){
232 }
233 void lock(){
234         m_locked = true;
235 }
236 void unlock(){
237         m_locked = false;
238 }
239 bool locked() const {
240         return m_locked;
241 }
242 };
243
244 class ScopedLock
245 {
246 Lock& m_lock;
247 public:
248 ScopedLock( Lock& lock ) : m_lock( lock ){
249         m_lock.lock();
250 }
251 ~ScopedLock(){
252         m_lock.unlock();
253 }
254 };
255
256 class LineLimitedTextOutputStream : public TextOutputStream
257 {
258 TextOutputStream& outputStream;
259 std::size_t count;
260 public:
261 LineLimitedTextOutputStream( TextOutputStream& outputStream, std::size_t count )
262         : outputStream( outputStream ), count( count ){
263 }
264 std::size_t write( const char* buffer, std::size_t length ){
265         if ( count != 0 ) {
266                 const char* p = buffer;
267                 const char* end = buffer + length;
268                 for (;; )
269                 {
270                         p = std::find( p, end, '\n' );
271                         if ( p == end ) {
272                                 break;
273                         }
274                         ++p;
275                         if ( --count == 0 ) {
276                                 length = p - buffer;
277                                 break;
278                         }
279                 }
280                 outputStream.write( buffer, length );
281         }
282         return length;
283 }
284 };
285
286 class PopupDebugMessageHandler : public DebugMessageHandler
287 {
288 StringOutputStream m_buffer;
289 Lock m_lock;
290 public:
291 TextOutputStream& getOutputStream(){
292         if ( !m_lock.locked() ) {
293                 return m_buffer;
294         }
295         return globalErrorStream();
296 }
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 );
305         if (GDEF_DEBUG) {
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;
308             m_buffer.clear();
309             return handled;
310         } else {
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);
313             m_buffer.clear();
314         }
315         }
316         return true;
317 }
318 };
319
320 typedef Static<PopupDebugMessageHandler> GlobalPopupDebugMessageHandler;
321
322 void streams_init(){
323         GlobalErrorStream::instance().setOutputStream( getSysPrintErrorStream() );
324         GlobalOutputStream::instance().setOutputStream( getSysPrintOutputStream() );
325 }
326
327 void paths_init(){
328         g_strSettingsPath = environment_get_home_path();
329
330         Q_mkdir( g_strSettingsPath.c_str() );
331
332         g_strAppPath = environment_get_app_path();
333
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)
338         {
339                 StringOutputStream path( 256 );
340                 path << g_strAppPath.c_str() << "bitmaps/";
341                 BitmapsPath_set( path.c_str() );
342         }
343
344         // we will set this right after the game selection is done
345         g_strGameToolsPath = g_strAppPath;
346 }
347
348 bool check_version_file( const char* filename, const char* version ){
349         TextFileInputStream file( filename );
350         if ( !file.failed() ) {
351                 char buf[10];
352                 buf[file.read( buf, 9 )] = '\0';
353
354                 // chomp it (the hard way)
355                 int chomp = 0;
356                 while ( buf[chomp] >= '0' && buf[chomp] <= '9' )
357                         chomp++;
358                 buf[chomp] = '\0';
359
360                 return string_equal( buf, version );
361         }
362         return false;
363 }
364
365 void create_global_pid(){
366         /*!
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
372          */
373         StringOutputStream g_pidFile( 256 ); ///< the global .pid file (only for global part of the startup)
374
375         g_pidFile << SettingsPath_get() << "radiant.pid";
376
377         FILE *pid;
378         pid = fopen( g_pidFile.c_str(), "r" );
379         if ( pid != 0 ) {
380                 fclose( pid );
381
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 );
386                 }
387
388                 // in debug, never prompt to clean registry, turn console logging auto after a failed start
389                 if (!GDEF_DEBUG) {
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?";
394
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();
397                         }
398
399                         msg.clear();
400                         msg << "Logging console output to " << SettingsPath_get()
401                                 << "radiant.log\nRefer to the log if Radiant fails to start again.";
402
403                         ui::alert(ui::root, msg.c_str(), "Radiant - Console Log", ui::alert_type::OK);
404                 }
405
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;
409                 Sys_LogFile( true );
410         }
411
412         // create a primary .pid for global init run
413         pid = fopen( g_pidFile.c_str(), "w" );
414         if ( pid ) {
415                 fclose( pid );
416         }
417 }
418
419 void remove_global_pid(){
420         StringOutputStream g_pidFile( 256 );
421         g_pidFile << SettingsPath_get() << "radiant.pid";
422
423         // close the primary
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 );
428         }
429 }
430
431 /*!
432    now the secondary game dependant .pid file
433    http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
434  */
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";
438
439         FILE *pid = fopen( g_pidGameFile.c_str(), "r" );
440         if ( pid != 0 ) {
441                 fclose( pid );
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 );
446                 }
447
448                 // in debug, never prompt to clean registry, turn console logging auto after a failed start
449                 if (!GDEF_DEBUG) {
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?";
454
455                         if (ui::alert(ui::root, msg.c_str(), "Radiant - Startup Failure", ui::alert_type::YESNO, ui::alert_icon::Question) == ui::alert_response::YES) {
456                                 Preferences_Reset();
457                         }
458
459                         msg.clear();
460                         msg << "Logging console output to " << SettingsPath_get()
461                                 << "radiant.log\nRefer to the log if Radiant fails to start again.";
462
463                         ui::alert(ui::root, msg.c_str(), "Radiant - Console Log", ui::alert_type::OK);
464                 }
465
466                 // force console logging on! (will go in prefs too)
467                 g_GamesDialog.m_bForceLogConsole = true;
468                 Sys_LogFile( true );
469         }
470         else
471         {
472                 // create one, will remove right after entering message loop
473                 pid = fopen( g_pidGameFile.c_str(), "w" );
474                 if ( pid ) {
475                         fclose( pid );
476                 }
477         }
478 }
479
480
481 /*!
482    now the secondary game dependant .pid file
483    http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=297
484  */
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() );
489 }
490
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() );
496 }
497
498 void user_shortcuts_save(){
499         StringOutputStream path( 256 );
500         path << SettingsPath_get() << g_pGameDescription->mGameFile.c_str() << '/';
501         SaveCommandMap( path.c_str() );
502 }
503
504 int main( int argc, char* argv[] ){
505         crt_init();
506
507         streams_init();
508
509 #if GDEF_OS_WINDOWS
510         HMODULE lib;
511         lib = LoadLibrary( "dwmapi.dll" );
512         if ( lib != 0 ) {
513                 void ( WINAPI *qDwmEnableComposition )( bool bEnable ) = ( void (WINAPI *) ( bool bEnable ) )GetProcAddress( lib, "DwmEnableComposition" );
514                 if ( qDwmEnableComposition ) {
515                         qDwmEnableComposition( FALSE );
516                 }
517                 FreeLibrary( lib );
518         }
519 #endif
520
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 );
525                 return -1;
526         }
527
528         // Gtk already removed parsed `--options`
529         if (argc == 2) {
530                 if ( strlen( argv[1] ) > 1 ) {
531                         if ( g_str_has_suffix( argv[1], ".map" ) ) {
532                                 if ( g_path_is_absolute( argv[1] ) ) {
533                                         mapname = argv[1];
534                                 }
535                                 else {
536                                         mapname = g_build_filename( g_get_current_dir(), argv[1], NULL );
537                                 }
538                         }
539                         else {
540                                 g_print( "bad file name, will not load: %s\n", argv[1] );
541                         }
542                 }
543         }
544         else if (argc > 2) {
545                 g_print ( "%s\n", "too many arguments" );
546                 return -1;
547         }
548
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 );
560
561         GlobalDebugMessageHandler::instance().setHandler( GlobalPopupDebugMessageHandler::instance() );
562
563         environment_init(argc, (char const **) argv);
564
565         paths_init();
566
567         show_splash();
568
569         create_global_pid();
570
571         GlobalPreferences_Init();
572
573         g_GamesDialog.Init();
574
575         g_strGameToolsPath = g_pGameDescription->mGameToolsPath;
576
577         remove_global_pid();
578
579         g_Preferences.Init(); // must occur before create_local_pid() to allow preferences to be reset
580
581         create_local_pid();
582
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 ) {
587                 Sys_LogFile( true );
588                 g_Console_enableLogging = true;
589                 g_GamesDialog.m_bForceLogConsole = false;
590         }
591
592
593         Radiant_Initialise();
594
595         user_shortcuts_init();
596
597         g_pParentWnd = 0;
598         g_pParentWnd = new MainFrame();
599
600         hide_splash();
601
602         if ( mapname != NULL ) {
603                 Map_LoadFile( mapname );
604         }
605         else if ( g_bLoadLastMap && !g_strLastMap.empty() ) {
606                 Map_LoadFile( g_strLastMap.c_str() );
607         }
608         else
609         {
610                 Map_New();
611         }
612
613         // load up shaders now that we have the map loaded
614         // eviltypeguy
615         TextureBrowser_ShowStartupShaders( GlobalTextureBrowser() );
616
617
618         remove_local_pid();
619
620         ui::main();
621
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;
626         }
627
628         Map_Free();
629
630         if ( !Map_Unnamed( g_map ) ) {
631                 g_strLastMap = Map_Name( g_map );
632         }
633
634         delete g_pParentWnd;
635
636         user_shortcuts_save();
637
638         Radiant_Shutdown();
639
640         // close the log file if any
641         Sys_LogFile( false );
642
643         return EXIT_SUCCESS;
644 }