src/supertux/main.cpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #include "supertux/main.hpp"
  18
  19 #include <config.h>
  20 #include <version.h>
  21
  22 #include <SDL_image.h>
  23 #include <physfs.h>
  24 #include <iostream>
  25 #include <binreloc.h>
  26 #include <tinygettext/log.hpp>
  27
  28 #ifdef MACOSX
  29 namespace supertux_apple {
  30 #  include <CoreFoundation/CoreFoundation.h>
  31 } // namespace supertux_apple
  32 #endif
  33
  34 #include "addon/addon_manager.hpp"
  35 #include "audio/sound_manager.hpp"
  36 #include "control/joystickkeyboardcontroller.hpp"
  37 #include "math/random_generator.hpp"
  38 #include "physfs/ifile_stream.hpp"
  39 #include "physfs/physfs_sdl.hpp"
  40 #include "physfs/physfs_file_system.hpp"
  41 #include "scripting/squirrel_util.hpp"
  42 #include "supertux/gameconfig.hpp"
  43 #include "supertux/globals.hpp"
  44 #include "supertux/screen_manager.hpp"
  45 #include "supertux/resources.hpp"
  46 #include "supertux/title_screen.hpp"
  47 #include "util/file_system.hpp"
  48 #include "util/gettext.hpp"
  49 #include "video/drawing_context.hpp"
  50 #include "worldmap/worldmap.hpp"
  51
  52 namespace { DrawingContext *context_pointer; }
  53
  54 void
  55 Main::init_config()
  56 {
  57   g_config = new Config();
  58   try {
  59     g_config->load();
  60   } catch(std::exception& e) {
  61     log_info << "Couldn't load config file: " << e.what() << ", using default settings" << std::endl;
  62   }
  63 }
  64
  65 void
  66 Main::init_tinygettext()
  67 {
  68   dictionary_manager = new tinygettext::DictionaryManager();
  69   tinygettext::Log::set_log_info_callback(0);
  70   dictionary_manager->set_filesystem(std::auto_ptr<tinygettext::FileSystem>(new PhysFSFileSystem));
  71
  72   dictionary_manager->add_directory("locale");
  73   dictionary_manager->set_charset("UTF-8");
  74
  75   // Config setting "locale" overrides language detection
  76   if (g_config->locale != "")
  77   {
  78     dictionary_manager->set_language(tinygettext::Language::from_name(g_config->locale));
  79   }
  80 }
  81
  82 void
  83 Main::init_physfs(const char* argv0)
  84 {
  85   if(!PHYSFS_init(argv0)) {
  86     std::stringstream msg;
  87     msg << "Couldn't initialize physfs: " << PHYSFS_getLastError();
  88     throw std::runtime_error(msg.str());
  89   }
  90
  91   // allow symbolic links
  92   PHYSFS_permitSymbolicLinks(1);
  93
  94   // Initialize physfs (this is a slightly modified version of
  95   // PHYSFS_setSaneConfig
  96   const char* application = "supertux2"; //instead of PACKAGE_NAME so we can coexist with MS1
  97   const char* userdir = PHYSFS_getUserDir();
  98   char* writedir = new char[strlen(userdir) + strlen(application) + 2];
  99
 100   // Set configuration directory
 101   sprintf(writedir, "%s.%s", userdir, application);
 102   if(!PHYSFS_setWriteDir(writedir)) {
 103     // try to create the directory
 104     char* mkdir = new char[strlen(application) + 2];
 105     sprintf(mkdir, ".%s", application);
 106     if(!PHYSFS_setWriteDir(userdir) || !PHYSFS_mkdir(mkdir)) {
 107       std::ostringstream msg;
 108       msg << "Failed creating configuration directory '"
 109           << writedir << "': " << PHYSFS_getLastError();
 110       delete[] writedir;
 111       delete[] mkdir;
 112       throw std::runtime_error(msg.str());
 113     }
 114     delete[] mkdir;
 115
 116     if(!PHYSFS_setWriteDir(writedir)) {
 117       std::ostringstream msg;
 118       msg << "Failed to use configuration directory '"
 119           <<  writedir << "': " << PHYSFS_getLastError();
 120       delete[] writedir;
 121       throw std::runtime_error(msg.str());
 122     }
 123   }
 124   PHYSFS_addToSearchPath(writedir, 0);
 125   delete[] writedir;
 126
 127   // when started from source dir...
 128   std::string dir = PHYSFS_getBaseDir();
 129   dir += "/data";
 130   std::string testfname = dir;
 131   testfname += "/credits.txt";
 132   bool sourcedir = false;
 133   FILE* f = fopen(testfname.c_str(), "r");
 134   if(f) {
 135     fclose(f);
 136     if(!PHYSFS_addToSearchPath(dir.c_str(), 1)) {
 137       log_warning << "Couldn't add '" << dir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 138     } else {
 139       sourcedir = true;
 140     }
 141   }
 142
 143 #ifdef MACOSX
 144   {
 145     using namespace supertux_apple;
 146
 147     // when started from Application file on Mac OS X...
 148     char path[PATH_MAX];
 149     CFBundleRef mainBundle = CFBundleGetMainBundle();
 150     assert(mainBundle != 0);
 151     CFURLRef mainBundleURL = CFBundleCopyBundleURL(mainBundle);
 152     assert(mainBundleURL != 0);
 153     CFStringRef pathStr = CFURLCopyFileSystemPath(mainBundleURL, kCFURLPOSIXPathStyle);
 154     assert(pathStr != 0);
 155     CFStringGetCString(pathStr, path, PATH_MAX, kCFStringEncodingUTF8);
 156     CFRelease(mainBundleURL);
 157     CFRelease(pathStr);
 158
 159     dir = std::string(path) + "/Contents/Resources/data";
 160     testfname = dir + "/credits.txt";
 161     sourcedir = false;
 162     f = fopen(testfname.c_str(), "r");
 163     if(f) {
 164       fclose(f);
 165       if(!PHYSFS_addToSearchPath(dir.c_str(), 1)) {
 166         log_warning << "Couldn't add '" << dir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 167       } else {
 168         sourcedir = true;
 169       }
 170     }
 171   }
 172 #endif
 173
 174 #ifdef _WIN32
 175   PHYSFS_addToSearchPath(".\\data", 1);
 176 #endif
 177
 178   if(!sourcedir) {
 179 #if defined(APPDATADIR) || defined(ENABLE_BINRELOC)
 180     std::string datadir;
 181 #ifdef ENABLE_BINRELOC
 182
 183     char* dir;
 184     br_init (NULL);
 185     dir = br_find_data_dir(APPDATADIR);
 186     datadir = dir;
 187     free(dir);
 188
 189 #else
 190     datadir = APPDATADIR;
 191 #endif
 192     if(!PHYSFS_addToSearchPath(datadir.c_str(), 1)) {
 193       log_warning << "Couldn't add '" << datadir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 194     }
 195 #endif
 196   }
 197
 198   //show search Path
 199   char** searchpath = PHYSFS_getSearchPath();
 200   for(char** i = searchpath; *i != NULL; i++)
 201     log_info << "[" << *i << "] is in the search path" << std::endl;
 202   PHYSFS_freeList(searchpath);
 203 }
 204
 205 void
 206 Main::print_usage(const char* argv0)
 207 {
 208   std::cerr << _("Usage: ") << argv0 << _(" [OPTIONS] [LEVELFILE]\n\n")
 209             << _("Options:\n"
 210                  "  -f, --fullscreen             Run in fullscreen mode\n"
 211                  "  -w, --window                 Run in window mode\n"
 212                  "  -g, --geometry WIDTHxHEIGHT  Run SuperTux in given resolution\n"
 213                  "  -a, --aspect WIDTH:HEIGHT    Run SuperTux with given aspect ratio\n"
 214                  "  -d, --default                Reset video settings to default values\n"
 215                  "  --renderer RENDERER          Use sdl, opengl, or auto to render\n"
 216                  "  --disable-sfx                Disable sound effects\n"
 217                  "  --disable-music              Disable music\n"
 218                  "  -h, --help                   Show this help message and quit\n"
 219                  "  -v, --version                Show SuperTux version and quit\n"
 220                  "  --console                    Enable ingame scripting console\n"
 221                  "  --noconsole                  Disable ingame scripting console\n"
 222                  "  --show-fps                   Display framerate in levels\n"
 223                  "  --no-show-fps                Do not display framerate in levels\n"
 224                  "  --record-demo FILE LEVEL     Record a demo to FILE\n"
 225                  "  --play-demo FILE LEVEL       Play a recorded demo\n"
 226                  "  -s, --debug-scripts          Enable script debugger.\n"
 227                  "\n")
 228             << std::flush;
 229 }
 230
 231 /**
 232  * Options that should be evaluated prior to any initializations at all go here
 233  */
 234 bool
 235 Main::pre_parse_commandline(int argc, char** argv)
 236 {
 237   for(int i = 1; i < argc; ++i) {
 238     std::string arg = argv[i];
 239
 240     if(arg == "--version" || arg == "-v") {
 241       std::cout << PACKAGE_NAME << " " << PACKAGE_VERSION << std::endl;
 242       return true;
 243     }
 244     if(arg == "--help" || arg == "-h") {
 245       print_usage(argv[0]);
 246       return true;
 247     }
 248   }
 249
 250   return false;
 251 }
 252
 253 /**
 254  * Options that should be evaluated after config is read go here
 255  */
 256 bool
 257 Main::parse_commandline(int argc, char** argv)
 258 {
 259   for(int i = 1; i < argc; ++i) {
 260     std::string arg = argv[i];
 261
 262     if(arg == "--fullscreen" || arg == "-f") {
 263       g_config->use_fullscreen = true;
 264     } else if(arg == "--default" || arg == "-d") {
 265       g_config->use_fullscreen = false;
 266
 267       g_config->window_size     = Size(800, 600);
 268       g_config->fullscreen_size = Size(800, 600);
 269       g_config->aspect_size     = Size(0, 0);  // auto detect
 270
 271     } else if(arg == "--window" || arg == "-w") {
 272       g_config->use_fullscreen = false;
 273     } else if(arg == "--geometry" || arg == "-g") {
 274       i += 1;
 275       if(i >= argc)
 276       {
 277         print_usage(argv[0]);
 278         throw std::runtime_error("Need to specify a size (WIDTHxHEIGHT) for geometry argument");
 279       }
 280       else
 281       {
 282         int width, height;
 283         if (sscanf(argv[i], "%dx%d", &width, &height) != 2)
 284         {
 285           print_usage(argv[0]);
 286           throw std::runtime_error("Invalid geometry spec, should be WIDTHxHEIGHT");
 287         }
 288         else
 289         {
 290           g_config->window_size     = Size(width, height);
 291           g_config->fullscreen_size = Size(width, height);
 292         }
 293       }
 294     } else if(arg == "--aspect" || arg == "-a") {
 295       i += 1;
 296       if(i >= argc)
 297       {
 298         print_usage(argv[0]);
 299         throw std::runtime_error("Need to specify a ratio (WIDTH:HEIGHT) for aspect ratio");
 300       }
 301       else
 302       {
 303         int aspect_width  = 0;
 304         int aspect_height = 0;
 305         if (strcmp(argv[i], "auto") == 0)
 306         {
 307           aspect_width  = 0;
 308           aspect_height = 0;
 309         }
 310         else if (sscanf(argv[i], "%d:%d", &aspect_width, &aspect_height) != 2)
 311         {
 312           print_usage(argv[0]);
 313           throw std::runtime_error("Invalid aspect spec, should be WIDTH:HEIGHT or auto");
 314         }
 315         else
 316         {
 317           float aspect_ratio = static_cast<float>(aspect_width) / static_cast<float>(aspect_height);
 318
 319           // use aspect ratio to calculate logical resolution
 320           if (aspect_ratio > 1) {
 321             g_config->aspect_size = Size(static_cast<int>(600 * aspect_ratio + 0.5),
 322                                          600);
 323           } else {
 324             g_config->aspect_size = Size(600,
 325                                          static_cast<int>(600 * 1/aspect_ratio + 0.5));
 326           }
 327         }
 328       }
 329     } else if(arg == "--renderer") {
 330       i += 1;
 331       if(i >= argc)
 332       {
 333         print_usage(argv[0]);
 334         throw std::runtime_error("Need to specify a renderer for renderer argument");
 335       }
 336       else
 337       {
 338         g_config->video = get_video_system(argv[i]);
 339       }
 340     } else if(arg == "--show-fps") {
 341       g_config->show_fps = true;
 342     } else if(arg == "--no-show-fps") {
 343       g_config->show_fps = false;
 344     } else if(arg == "--console") {
 345       g_config->console_enabled = true;
 346     } else if(arg == "--noconsole") {
 347       g_config->console_enabled = false;
 348     } else if(arg == "--disable-sfx") {
 349       g_config->sound_enabled = false;
 350     } else if(arg == "--disable-music") {
 351       g_config->music_enabled = false;
 352     } else if(arg == "--play-demo") {
 353       if(i+1 >= argc) {
 354         print_usage(argv[0]);
 355         throw std::runtime_error("Need to specify a demo filename");
 356       }
 357       g_config->start_demo = argv[++i];
 358     } else if(arg == "--record-demo") {
 359       if(i+1 >= argc) {
 360         print_usage(argv[0]);
 361         throw std::runtime_error("Need to specify a demo filename");
 362       }
 363       g_config->record_demo = argv[++i];
 364     } else if(arg == "--debug-scripts" || arg == "-s") {
 365       g_config->enable_script_debugger = true;
 366     } else if(arg[0] != '-') {
 367       g_config->start_level = arg;
 368     } else {
 369       log_warning << "Unknown option '" << arg << "'. Use --help to see a list of options" << std::endl;
 370       return true;
 371     }
 372   }
 373
 374   return false;
 375 }
 376
 377 void
 378 Main::init_sdl()
 379 {
 380   if(SDL_Init(SDL_INIT_TIMER | SDL_INIT_VIDEO | SDL_INIT_JOYSTICK) < 0) {
 381     std::stringstream msg;
 382     msg << "Couldn't initialize SDL: " << SDL_GetError();
 383     throw std::runtime_error(msg.str());
 384   }
 385   // just to be sure
 386   atexit(SDL_Quit);
 387
 388   SDL_EnableUNICODE(1);
 389
 390   // wait 100ms and clear SDL event queue because sometimes we have random
 391   // joystick events in the queue on startup...
 392   SDL_Delay(100);
 393   SDL_Event dummy;
 394   while(SDL_PollEvent(&dummy))
 395     ;
 396 }
 397
 398 void
 399 Main::init_rand()
 400 {
 401   g_config->random_seed = systemRandom.srand(g_config->random_seed);
 402
 403   //const char *how = config->random_seed? ", user fixed.": ", from time().";
 404   //log_info << "Using random seed " << config->random_seed << how << std::endl;
 405 }
 406
 407 void
 408 Main::init_video()
 409 {
 410   // FIXME: Add something here
 411   SCREEN_WIDTH  = 800;
 412   SCREEN_HEIGHT = 600;
 413
 414   context_pointer->init_renderer();
 415   g_screen = SDL_GetVideoSurface();
 416
 417   SDL_WM_SetCaption(PACKAGE_NAME " " PACKAGE_VERSION, 0);
 418
 419   // set icon
 420 #ifdef MACOSX
 421   const char* icon_fname = "images/engine/icons/supertux-256x256.png";
 422 #else
 423   const char* icon_fname = "images/engine/icons/supertux.xpm";
 424 #endif
 425   SDL_Surface* icon;
 426   try {
 427     icon = IMG_Load_RW(get_physfs_SDLRWops(icon_fname), true);
 428   } catch (const std::runtime_error& err) {
 429     icon = 0;
 430     log_warning << "Couldn't load icon '" << icon_fname << "': " << err.what() << std::endl;
 431   }
 432   if(icon != 0) {
 433     SDL_WM_SetIcon(icon, 0);
 434     SDL_FreeSurface(icon);
 435   }
 436 #ifndef NDEBUG
 437   else {
 438     log_warning << "Couldn't load icon '" << icon_fname << "'" << std::endl;
 439   }
 440 #endif
 441
 442   SDL_ShowCursor(0);
 443
 444   log_info << (g_config->use_fullscreen?"fullscreen ":"window ")
 445            << " Window: "     << g_config->window_size
 446            << " Fullscreen: " << g_config->fullscreen_size
 447            << " Area: "       << g_config->aspect_size << std::endl;
 448 }
 449
 450 void
 451 Main::init_audio()
 452 {
 453   sound_manager = new SoundManager();
 454
 455   sound_manager->enable_sound(g_config->sound_enabled);
 456   sound_manager->enable_music(g_config->music_enabled);
 457 }
 458
 459 void
 460 Main::quit_audio()
 461 {
 462   if(sound_manager != NULL) {
 463     delete sound_manager;
 464     sound_manager = NULL;
 465   }
 466 }
 467
 468 void
 469 Main::wait_for_event(float min_delay, float max_delay)
 470 {
 471   assert(min_delay <= max_delay);
 472
 473   Uint32 min = (Uint32) (min_delay * 1000);
 474   Uint32 max = (Uint32) (max_delay * 1000);
 475
 476   Uint32 ticks = SDL_GetTicks();
 477   while(SDL_GetTicks() - ticks < min) {
 478     SDL_Delay(10);
 479     sound_manager->update();
 480   }
 481
 482   // clear event queue
 483   SDL_Event event;
 484   while (SDL_PollEvent(&event))
 485   {}
 486
 487   /* Handle events: */
 488   bool running = false;
 489   ticks = SDL_GetTicks();
 490   while(running) {
 491     while(SDL_PollEvent(&event)) {
 492       switch(event.type) {
 493         case SDL_QUIT:
 494           g_screen_manager->quit();
 495           break;
 496         case SDL_KEYDOWN:
 497         case SDL_JOYBUTTONDOWN:
 498         case SDL_MOUSEBUTTONDOWN:
 499           running = false;
 500       }
 501     }
 502     if(SDL_GetTicks() - ticks >= (max - min))
 503       running = false;
 504     sound_manager->update();
 505     SDL_Delay(10);
 506   }
 507 }
 508
 509 #ifndef NDEBUG
 510 static Uint32 last_timelog_ticks = 0;
 511 static const char* last_timelog_component = 0;
 512
 513 static inline void timelog(const char* component)
 514 {
 515   Uint32 current_ticks = SDL_GetTicks();
 516
 517   if(last_timelog_component != 0) {
 518     log_info << "Component '" << last_timelog_component <<  "' finished after " << (current_ticks - last_timelog_ticks) / 1000.0 << " seconds" << std::endl;
 519   }
 520
 521   last_timelog_ticks = current_ticks;
 522   last_timelog_component = component;
 523 }
 524 #else
 525 static inline void timelog(const char* )
 526 {
 527 }
 528 #endif
 529
 530 int
 531 Main::main(int argc, char** argv)
 532 {
 533   int result = 0;
 534
 535   try {
 536
 537     if(pre_parse_commandline(argc, argv))
 538       return 0;
 539
 540     Console::instance = new Console();
 541     init_physfs(argv[0]);
 542     init_sdl();
 543
 544     timelog("controller");
 545     g_main_controller = new JoystickKeyboardController();
 546
 547     timelog("config");
 548     init_config();
 549
 550     timelog("addons");
 551     AddonManager::get_instance().load_addons();
 552
 553     timelog("tinygettext");
 554     init_tinygettext();
 555
 556     timelog("commandline");
 557     if(parse_commandline(argc, argv))
 558       return 0;
 559
 560     timelog("audio");
 561     init_audio();
 562
 563     timelog("video");
 564     DrawingContext context;
 565     context_pointer = &context;
 566     init_video();
 567
 568     Console::instance->init_graphics();
 569
 570     timelog("scripting");
 571     Scripting::init_squirrel(g_config->enable_script_debugger);
 572
 573     timelog("resources");
 574     Resources::load_shared();
 575
 576     timelog(0);
 577
 578     g_screen_manager = new ScreenManager();
 579     if(g_config->start_level != "") {
 580       // we have a normal path specified at commandline, not a physfs path.
 581       // So we simply mount that path here...
 582       std::string dir = FileSystem::dirname(g_config->start_level);
 583       log_debug << "Adding dir: " << dir << std::endl;
 584       PHYSFS_addToSearchPath(dir.c_str(), true);
 585
 586       if(g_config->start_level.size() > 4 &&
 587          g_config->start_level.compare(g_config->start_level.size() - 5, 5, ".stwm") == 0) {
 588         init_rand();
 589         g_screen_manager->push_screen(new WorldMapNS::WorldMap(
 590                                  FileSystem::basename(g_config->start_level)));
 591       } else {
 592         init_rand();//If level uses random eg. for
 593         // rain particles before we do this:
 594         std::auto_ptr<GameSession> session (
 595           new GameSession(FileSystem::basename(g_config->start_level)));
 596
 597         g_config->random_seed =session->get_demo_random_seed(g_config->start_demo);
 598         init_rand();//initialise generator with seed from session
 599
 600         if(g_config->start_demo != "")
 601           session->play_demo(g_config->start_demo);
 602
 603         if(g_config->record_demo != "")
 604           session->record_demo(g_config->record_demo);
 605         g_screen_manager->push_screen(session.release());
 606       }
 607     } else {
 608       init_rand();
 609       g_screen_manager->push_screen(new TitleScreen());
 610     }
 611
 612     //init_rand(); PAK: this call might subsume the above 3, but I'm chicken!
 613     g_screen_manager->run(context);
 614   } catch(std::exception& e) {
 615     log_fatal << "Unexpected exception: " << e.what() << std::endl;
 616     result = 1;
 617   } catch(...) {
 618     log_fatal << "Unexpected exception" << std::endl;
 619     result = 1;
 620   }
 621
 622   delete g_screen_manager;
 623   g_screen_manager = NULL;
 624
 625   Resources::unload_shared();
 626   quit_audio();
 627
 628   if(g_config)
 629     g_config->save();
 630   delete g_config;
 631   g_config = NULL;
 632   delete g_main_controller;
 633   g_main_controller = NULL;
 634   delete Console::instance;
 635   Console::instance = NULL;
 636   Scripting::exit_squirrel();
 637   delete texture_manager;
 638   texture_manager = NULL;
 639   SDL_Quit();
 640   PHYSFS_deinit();
 641
 642   return result;
 643 }
 644
 645 /* EOF */