src/main.cpp

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