radiant/qe3.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 /*
  23    The following source code is licensed by Id Software and subject to the terms of
  24    its LIMITED USE SOFTWARE LICENSE AGREEMENT, a copy of which is included with
  25    GtkRadiant. If you did not receive a LIMITED USE SOFTWARE LICENSE AGREEMENT,
  26    please contact Id Software immediately at info@idsoftware.com.
  27  */
  28
  29 //
  30 // Linux stuff
  31 //
  32 // Leonardo Zide (leo@lokigames.com)
  33 //
  34
  35 #include "defaults.h"
  36 #include "qe3.h"
  37 #include "globaldefs.h"
  38
  39 #include <gtk/gtk.h>
  40
  41 #include "debugging/debugging.h"
  42
  43 #include "ifilesystem.h"
  44 //#include "imap.h"
  45
  46 #include <map>
  47
  48 #include <uilib/uilib.h>
  49
  50 #include "stream/textfilestream.h"
  51 #include "cmdlib.h"
  52 #include "stream/stringstream.h"
  53 #include "os/path.h"
  54 #include "scenelib.h"
  55
  56 #include "gtkutil/messagebox.h"
  57 #include "error.h"
  58 #include "map.h"
  59 #include "build.h"
  60 #include "points.h"
  61 #include "camwindow.h"
  62 #include "mainframe.h"
  63 #include "preferences.h"
  64 #include "watchbsp.h"
  65 #include "autosave.h"
  66 #include "convert.h"
  67
  68 QEGlobals_t g_qeglobals;
  69
  70
  71 #if GDEF_OS_WINDOWS
  72 #define PATH_MAX 260
  73 #endif
  74
  75
  76 void QE_InitVFS(){
  77         // VFS initialization -----------------------
  78         // we will call GlobalFileSystem().initDirectory, giving the directories to look in (for files in pk3's and for standalone files)
  79         // we need to call in order, the mod ones first, then the base ones .. they will be searched in this order
  80         // *nix systems have a dual filesystem in ~/.q3a, which is searched first .. so we need to add that too
  81
  82         const char* gamename = gamename_get();
  83         const char* basegame = basegame_get();
  84         const char* userRoot = g_qeglobals.m_userEnginePath.c_str();
  85         const char* globalRoot = EnginePath_get();
  86
  87         // editor builtin VFS
  88         StringOutputStream editorGamePath( 256 );
  89         editorGamePath << GlobalRadiant().getDataPath() << DEFAULT_EDITORVFS_DIRNAME;
  90         GlobalFileSystem().initDirectory( editorGamePath.c_str() );
  91
  92         // if we have a mod dir
  93         if ( !string_equal( gamename, basegame ) ) {
  94                 // ~/.<gameprefix>/<fs_game>
  95                 if ( userRoot && !g_disableHomePath ) {
  96                         StringOutputStream userGamePath( 256 );
  97                         userGamePath << userRoot << gamename << '/';
  98                         GlobalFileSystem().initDirectory( userGamePath.c_str() );
  99                 }
 100
 101                 // <fs_basepath>/<fs_game>
 102                 if ( !g_disableEnginePath ) {
 103                         StringOutputStream globalGamePath( 256 );
 104                         globalGamePath << globalRoot << gamename << '/';
 105                         GlobalFileSystem().initDirectory( globalGamePath.c_str() );
 106                 }
 107         }
 108
 109         // ~/.<gameprefix>/<fs_main>
 110         if ( userRoot && !g_disableHomePath ) {
 111                 StringOutputStream userBasePath( 256 );
 112                 userBasePath << userRoot << basegame << '/';
 113                 GlobalFileSystem().initDirectory( userBasePath.c_str() );
 114         }
 115
 116         // <fs_basepath>/<fs_main>
 117         if ( !g_disableEnginePath ) {
 118                 StringOutputStream globalBasePath( 256 );
 119                 globalBasePath << globalRoot << basegame << '/';
 120                 GlobalFileSystem().initDirectory( globalBasePath.c_str() );
 121         }
 122
 123         // extra pakpaths
 124         for ( int i = 0; i < g_pakPathCount; i++ ) {
 125                 if (g_strcmp0( g_strPakPath[i].c_str(), "")) {
 126                         GlobalFileSystem().initDirectory( g_strPakPath[i].c_str() );
 127                 }
 128         }
 129 }
 130
 131 int g_numbrushes = 0;
 132 int g_numentities = 0;
 133
 134 void QE_UpdateStatusBar(){
 135         char buffer[128];
 136         sprintf( buffer, "Brushes: %d Entities: %d", g_numbrushes, g_numentities );
 137         g_pParentWnd->SetStatusText( g_pParentWnd->m_brushcount_status, buffer );
 138 }
 139
 140 SimpleCounter g_brushCount;
 141
 142 void QE_brushCountChanged(){
 143         g_numbrushes = int(g_brushCount.get() );
 144         QE_UpdateStatusBar();
 145 }
 146
 147 SimpleCounter g_entityCount;
 148
 149 void QE_entityCountChanged(){
 150         g_numentities = int(g_entityCount.get() );
 151         QE_UpdateStatusBar();
 152 }
 153
 154 bool ConfirmModified( const char* title ){
 155         if ( !Map_Modified( g_map ) ) {
 156                 return true;
 157         }
 158
 159         auto result = ui::alert( MainFrame_getWindow(), "The current map has changed since it was last saved.\nDo you want to save the current map before continuing?", title, ui::alert_type::YESNOCANCEL, ui::alert_icon::Question );
 160         if ( result == ui::alert_response::CANCEL ) {
 161                 return false;
 162         }
 163         if ( result == ui::alert_response::YES ) {
 164                 if ( Map_Unnamed( g_map ) ) {
 165                         return Map_SaveAs();
 166                 }
 167                 else
 168                 {
 169                         return Map_Save();
 170                 }
 171         }
 172         return true;
 173 }
 174
 175 void bsp_init(){
 176         // this is expected to not be used since
 177         // ".[ExecutableType]" is replaced by "[ExecutableExt]"
 178         const char *exe_ext = GDEF_OS_EXE_EXT;
 179         build_set_variable( "ExecutableType", exe_ext[0] == '\0' ? exe_ext : exe_ext + 1 );
 180
 181         build_set_variable( "ExecutableExt", GDEF_OS_EXE_EXT );
 182         build_set_variable( "RadiantPath", AppPath_get() );
 183         build_set_variable( "EnginePath", EnginePath_get() );
 184         build_set_variable( "UserEnginePath", g_qeglobals.m_userEnginePath.c_str() );
 185
 186         build_set_variable( "MonitorAddress", ( g_WatchBSP_Enabled ) ? "127.0.0.1:39000" : "" );
 187
 188         build_set_variable( "GameName", gamename_get() );
 189
 190         StringBuffer ExtraQ3map2Args;
 191         // extra pakpaths
 192         for ( int i = 0; i < g_pakPathCount; i++ ) {
 193                 if ( g_strcmp0( g_strPakPath[i].c_str(), "") ) {
 194                         ExtraQ3map2Args.push_string( " -fs_pakpath \"" );
 195                         ExtraQ3map2Args.push_string( g_strPakPath[i].c_str() );
 196                         ExtraQ3map2Args.push_string( "\"" );
 197                 }
 198         }
 199
 200         // extra switches
 201         if ( g_disableEnginePath ) {
 202                 ExtraQ3map2Args.push_string( " -fs_nobasepath " );
 203         }
 204
 205         if ( g_disableHomePath ) {
 206                 ExtraQ3map2Args.push_string( " -fs_nohomepath " );
 207         }
 208
 209         build_set_variable( "ExtraQ3map2Args", ExtraQ3map2Args.c_str() );
 210
 211         const char* mapname = Map_Name( g_map );
 212         StringOutputStream name( 256 );
 213         name << StringRange( mapname, path_get_filename_base_end( mapname ) ) << ".bsp";
 214
 215         build_set_variable( "MapFile", mapname );
 216         build_set_variable( "BspFile", name.c_str() );
 217 }
 218
 219 void bsp_shutdown(){
 220         build_clear_variables();
 221 }
 222
 223 class ArrayCommandListener : public CommandListener
 224 {
 225 GPtrArray* m_array;
 226 public:
 227 ArrayCommandListener(){
 228         m_array = g_ptr_array_new();
 229 }
 230
 231 ~ArrayCommandListener(){
 232         g_ptr_array_free( m_array, TRUE );
 233 }
 234
 235 void execute( const char* command ){
 236         g_ptr_array_add( m_array, g_strdup( command ) );
 237 }
 238
 239 GPtrArray* array() const {
 240         return m_array;
 241 }
 242 };
 243
 244 class BatchCommandListener : public CommandListener
 245 {
 246 TextOutputStream& m_file;
 247 std::size_t m_commandCount;
 248 const char* m_outputRedirect;
 249 public:
 250 BatchCommandListener( TextOutputStream& file, const char* outputRedirect ) : m_file( file ), m_commandCount( 0 ), m_outputRedirect( outputRedirect ){
 251 }
 252
 253 void execute( const char* command ){
 254         m_file << command;
 255         if ( m_commandCount == 0 ) {
 256                 m_file << " > ";
 257         }
 258         else
 259         {
 260                 m_file << " >> ";
 261         }
 262         m_file << "\"" << m_outputRedirect << "\"";
 263         m_file << "\n";
 264         ++m_commandCount;
 265 }
 266 };
 267
 268 bool Region_cameraValid(){
 269         Vector3 vOrig( vector3_snapped( Camera_getOrigin( *g_pParentWnd->GetCamWnd() ) ) );
 270
 271         for ( int i = 0 ; i < 3 ; i++ )
 272         {
 273                 if ( vOrig[i] > region_maxs[i] || vOrig[i] < region_mins[i] ) {
 274                         return false;
 275                 }
 276         }
 277         return true;
 278 }
 279
 280
 281 void RunBSP( const char* name ){
 282         // http://zerowing.idsoftware.com/bugzilla/show_bug.cgi?id=503
 283         // make sure we don't attempt to region compile a map with the camera outside the region
 284         if ( region_active && !Region_cameraValid() ) {
 285                 globalErrorStream() << "The camera must be in the region to start a region compile.\n";
 286                 return;
 287         }
 288
 289         SaveMap();
 290
 291         if ( Map_Unnamed( g_map ) ) {
 292                 globalOutputStream() << "build cancelled\n";
 293                 return;
 294         }
 295
 296         if ( g_SnapShots_Enabled && !Map_Unnamed( g_map ) && Map_Modified( g_map ) ) {
 297                 Map_Snapshot();
 298         }
 299
 300         if ( region_active ) {
 301                 const char* mapname = Map_Name( g_map );
 302                 StringOutputStream name( 256 );
 303                 name << StringRange( mapname, path_get_filename_base_end( mapname ) ) << ".reg";
 304                 Map_SaveRegion( name.c_str() );
 305         }
 306
 307         Pointfile_Delete();
 308
 309         bsp_init();
 310
 311         if ( g_WatchBSP_Enabled ) {
 312                 ArrayCommandListener listener;
 313                 build_run( name, listener );
 314                 // grab the file name for engine running
 315                 const char* fullname = Map_Name( g_map );
 316                 StringOutputStream bspname( 64 );
 317                 bspname << StringRange( path_get_filename_start( fullname ), path_get_filename_base_end( fullname ) );
 318                 BuildMonitor_Run( listener.array(), bspname.c_str() );
 319         }
 320         else
 321         {
 322                 char junkpath[PATH_MAX];
 323                 strcpy( junkpath, SettingsPath_get() );
 324                 strcat( junkpath, "junk.txt" );
 325
 326                 char batpath[PATH_MAX];
 327 #if GDEF_OS_POSIX
 328                 strcpy( batpath, SettingsPath_get() );
 329                 strcat( batpath, "qe3bsp.sh" );
 330 #elif GDEF_OS_WINDOWS
 331                 strcpy( batpath, SettingsPath_get() );
 332                 strcat( batpath, "qe3bsp.bat" );
 333 #else
 334 #error "unsupported platform"
 335 #endif
 336                 bool written = false;
 337                 {
 338                         TextFileOutputStream batchFile( batpath );
 339                         if ( !batchFile.failed() ) {
 340 #if GDEF_OS_POSIX
 341                                 batchFile << "#!/bin/sh \n\n";
 342 #endif
 343                                 BatchCommandListener listener( batchFile, junkpath );
 344                                 build_run( name, listener );
 345                                 written = true;
 346                         }
 347                 }
 348                 if ( written ) {
 349 #if GDEF_OS_POSIX
 350                         chmod( batpath, 0744 );
 351 #endif
 352                         globalOutputStream() << "Writing the compile script to '" << batpath << "'\n";
 353                         globalOutputStream() << "The build output will be saved in '" << junkpath << "'\n";
 354                         Q_Exec( batpath, NULL, NULL, true, false );
 355                 }
 356         }
 357
 358         bsp_shutdown();
 359 }
 360
 361 // =============================================================================
 362 // Sys_ functions
 363
 364 void Sys_SetTitle( const char *text, bool modified ){
 365         StringOutputStream title;
 366         title << text;
 367
 368         if ( modified ) {
 369                 title << " *";
 370         }
 371
 372         gtk_window_set_title(MainFrame_getWindow(), title.c_str() );
 373 }
 374
 375 bool g_bWaitCursor = false;
 376
 377 void Sys_BeginWait( void ){
 378         ScreenUpdates_Disable( "Processing...", "Please Wait" );
 379         GdkCursor *cursor = gdk_cursor_new( GDK_WATCH );
 380         gdk_window_set_cursor( gtk_widget_get_window(MainFrame_getWindow()), cursor );
 381         gdk_cursor_unref( cursor );
 382         g_bWaitCursor = true;
 383 }
 384
 385 void Sys_EndWait( void ){
 386         ScreenUpdates_Enable();
 387         gdk_window_set_cursor(gtk_widget_get_window(MainFrame_getWindow()), 0 );
 388         g_bWaitCursor = false;
 389 }
 390
 391 void Sys_Beep( void ){
 392         gdk_beep();
 393 }