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 <time.h>
  29 #include <stdlib.h>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #include <unistd.h>
  33 #include <assert.h>
  34 #include <physfs.h>
  35 #include <SDL.h>
  36 #include <SDL_image.h>
  37 #include <GL/gl.h>
  38
  39 #include "gameconfig.hpp"
  40 #include "resources.hpp"
  41 #include "gettext.hpp"
  42 #include "audio/sound_manager.hpp"
  43 #include "video/surface.hpp"
  44 #include "video/texture_manager.hpp"
  45 #include "video/glutil.hpp"
  46 #include "control/joystickkeyboardcontroller.hpp"
  47 #include "options_menu.hpp"
  48 #include "mainloop.hpp"
  49 #include "title.hpp"
  50 #include "game_session.hpp"
  51 #include "scripting/level.hpp"
  52 #include "scripting/squirrel_util.hpp"
  53 #include "file_system.hpp"
  54 #include "physfs/physfs_sdl.hpp"
  55 #include "random_generator.hpp"
  56 #include "worldmap/worldmap.hpp"
  57 #include "binreloc/binreloc.h"
  58
  59 SDL_Surface* screen = 0;
  60 JoystickKeyboardController* main_controller = 0;
  61 TinyGetText::DictionaryManager dictionary_manager;
  62
  63 int SCREEN_WIDTH;
  64 int SCREEN_HEIGHT;
  65
  66 static void init_config()
  67 {
  68   config = new Config();
  69   try {
  70     config->load();
  71   } catch(std::exception& e) {
  72     log_info << "Couldn't load config file: " << e.what() << ", using default settings" << std::endl;
  73   }
  74 }
  75
  76 static void init_tinygettext()
  77 {
  78   dictionary_manager.add_directory("locale");
  79   dictionary_manager.set_charset("UTF-8");
  80 }
  81
  82 static void init_physfs(const char* argv0)
  83 {
  84   if(!PHYSFS_init(argv0)) {
  85     std::stringstream msg;
  86     msg << "Couldn't initialize physfs: " << PHYSFS_getLastError();
  87     throw std::runtime_error(msg.str());
  88   }
  89
  90   // Initialize physfs (this is a slightly modified version of
  91   // PHYSFS_setSaneConfig
  92   const char* application = "supertux2"; //instead of PACKAGE_NAME so we can coexist with MS1
  93   const char* userdir = PHYSFS_getUserDir();
  94   const char* dirsep = PHYSFS_getDirSeparator();
  95   char* writedir = new char[strlen(userdir) + strlen(application) + 2];
  96
  97   // Set configuration directory
  98   sprintf(writedir, "%s.%s", userdir, application);
  99   if(!PHYSFS_setWriteDir(writedir)) {
 100     // try to create the directory
 101     char* mkdir = new char[strlen(application) + 2];
 102     sprintf(mkdir, ".%s", application);
 103     if(!PHYSFS_setWriteDir(userdir) || !PHYSFS_mkdir(mkdir)) {
 104       std::ostringstream msg;
 105       msg << "Failed creating configuration directory '"
 106           << writedir << "': " << PHYSFS_getLastError();
 107       delete[] writedir;
 108       delete[] mkdir;
 109       throw std::runtime_error(msg.str());
 110     }
 111     delete[] mkdir;
 112
 113     if(!PHYSFS_setWriteDir(writedir)) {
 114       std::ostringstream msg;
 115       msg << "Failed to use configuration directory '"
 116           <<  writedir << "': " << PHYSFS_getLastError();
 117       delete[] writedir;
 118       throw std::runtime_error(msg.str());
 119     }
 120   }
 121   PHYSFS_addToSearchPath(writedir, 0);
 122   delete[] writedir;
 123
 124   // Search for archives and add them to the search path
 125   const char* archiveExt = "zip";
 126   char** rc = PHYSFS_enumerateFiles("/");
 127   size_t extlen = strlen(archiveExt);
 128
 129   for(char** i = rc; *i != 0; ++i) {
 130     size_t l = strlen(*i);
 131     if((l > extlen) && ((*i)[l - extlen - 1] == '.')) {
 132       const char* ext = (*i) + (l - extlen);
 133       if(strcasecmp(ext, archiveExt) == 0) {
 134         const char* d = PHYSFS_getRealDir(*i);
 135         char* str = new char[strlen(d) + strlen(dirsep) + l + 1];
 136         sprintf(str, "%s%s%s", d, dirsep, *i);
 137         PHYSFS_addToSearchPath(str, 1);
 138         delete[] str;
 139       }
 140     }
 141   }
 142
 143   PHYSFS_freeList(rc);
 144
 145   // when started from source dir...
 146   std::string dir = PHYSFS_getBaseDir();
 147   dir += "/data";
 148   std::string testfname = dir;
 149   testfname += "/credits.txt";
 150   bool sourcedir = false;
 151   FILE* f = fopen(testfname.c_str(), "r");
 152   if(f) {
 153     fclose(f);
 154     if(!PHYSFS_addToSearchPath(dir.c_str(), 1)) {
 155       log_warning << "Couldn't add '" << dir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 156     } else {
 157       sourcedir = true;
 158     }
 159   }
 160
 161 #ifdef MACOSX
 162   // when started from Application file on Mac OS X...
 163   dir = PHYSFS_getBaseDir();
 164   dir += "SuperTux.app/Contents/Resources/data";
 165   testfname = dir + "/credits.txt";
 166   sourcedir = false;
 167   f = fopen(testfname.c_str(), "r");
 168   if(f) {
 169     fclose(f);
 170     if(!PHYSFS_addToSearchPath(dir.c_str(), 1)) {
 171       log_warning << "Couldn't add '" << dir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 172     } else {
 173       sourcedir = true;
 174     }
 175   }
 176 #endif
 177
 178 #ifdef _WIN32
 179   PHYSFS_addToSearchPath(".\\data", 1);
 180 #endif
 181
 182   if(!sourcedir) {
 183 #if defined(APPDATADIR) || defined(ENABLE_BINRELOC)
 184     std::string datadir;
 185 #ifdef ENABLE_BINRELOC
 186
 187     char* dir;
 188     br_init (NULL);
 189     dir = br_find_data_dir(APPDATADIR);
 190     datadir = dir;
 191     datadir += "/" PACKAGE_NAME;
 192     free(dir);
 193
 194 #else
 195     datadir = APPDATADIR;
 196 #endif
 197     if(!PHYSFS_addToSearchPath(datadir.c_str(), 1)) {
 198       log_warning << "Couldn't add '" << datadir << "' to physfs searchpath: " << PHYSFS_getLastError() << std::endl;
 199     }
 200 #endif
 201   }
 202
 203   // allow symbolic links
 204   PHYSFS_permitSymbolicLinks(1);
 205
 206   //show search Path
 207   for(char** i = PHYSFS_getSearchPath(); *i != NULL; i++)
 208     log_info << "[" << *i << "] is in the search path" << std::endl;
 209 }
 210
 211 static void print_usage(const char* argv0)
 212 {
 213   fprintf(stderr, _("Usage: %s [OPTIONS] [LEVELFILE]\n\n"), argv0);
 214   fprintf(stderr,
 215           _("Options:\n"
 216             "  -f, --fullscreen             Run in fullscreen mode\n"
 217             "  -w, --window                 Run in window mode\n"
 218             "  -g, --geometry WIDTHxHEIGHT  Run SuperTux in given resolution\n"
 219             "  -a, --aspect WIDTH:HEIGHT    Run SuperTux with given aspect ratio\n"
 220             "  --disable-sfx                Disable sound effects\n"
 221             "  --disable-music              Disable music\n"
 222             "  --help                       Show this help message\n"
 223             "  --version                    Display SuperTux version and quit\n"
 224             "  --console                    Enable ingame scripting console\n"
 225             "  --noconsole                  Disable ingame scripting console\n"
 226             "  --show-fps                   Display framerate in levels\n"
 227             "  --no-show-fps                Do not display framerate in levels\n"
 228             "  --record-demo FILE LEVEL     Record a demo to FILE\n"
 229             "  --play-demo FILE LEVEL       Play a recorded demo\n"
 230             "\n"));
 231 }
 232
 233 /**
 234  * Options that should be evaluated prior to any initializations at all go here
 235  */
 236 static bool pre_parse_commandline(int argc, char** argv)
 237 {
 238   for(int i = 1; i < argc; ++i) {
 239     std::string arg = argv[i];
 240
 241     if(arg == "--help") {
 242       print_usage(argv[0]);
 243       return true;
 244     } else if(arg == "--version") {
 245       std::cout << PACKAGE_NAME << " " << PACKAGE_VERSION << std::endl;
 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 static bool parse_commandline(int argc, char** argv)
 257 {
 258   for(int i = 1; i < argc; ++i) {
 259     std::string arg = argv[i];
 260
 261     if(arg == "--fullscreen" || arg == "-f") {
 262       config->use_fullscreen = true;
 263     } else if(arg == "--window" || arg == "-w") {
 264       config->use_fullscreen = false;
 265     } else if(arg == "--geometry" || arg == "-g") {
 266       if(i+1 >= argc) {
 267         print_usage(argv[0]);
 268         throw std::runtime_error("Need to specify a parameter for geometry switch");
 269       }
 270       if(sscanf(argv[++i], "%dx%d", &config->screenwidth, &config->screenheight)
 271          != 2) {
 272         print_usage(argv[0]);
 273         throw std::runtime_error("Invalid geometry spec, should be WIDTHxHEIGHT");
 274       }
 275     } else if(arg == "--aspect" || arg == "-a") {
 276       if(i+1 >= argc) {
 277         print_usage(argv[0]);
 278         throw std::runtime_error("Need to specify a parameter for aspect switch");
 279       }
 280       if(sscanf(argv[++i], "%d:%d", &config->aspectwidth, &config->aspectheight)
 281          != 2) {
 282         print_usage(argv[0]);
 283         throw std::runtime_error("Invalid aspect spec, should be WIDTH:HEIGHT");
 284       }
 285     } else if(arg == "--show-fps") {
 286       config->show_fps = true;
 287     } else if(arg == "--no-show-fps") {
 288       config->show_fps = false;
 289     } else if(arg == "--console") {
 290       config->console_enabled = true;
 291     } else if(arg == "--noconsole") {
 292       config->console_enabled = false;
 293     } else if(arg == "--disable-sfx") {
 294       config->sound_enabled = false;
 295     } else if(arg == "--disable-music") {
 296       config->music_enabled = false;
 297     } else if(arg == "--play-demo") {
 298       if(i+1 >= argc) {
 299         print_usage(argv[0]);
 300         throw std::runtime_error("Need to specify a demo filename");
 301       }
 302       config->start_demo = argv[++i];
 303     } else if(arg == "--record-demo") {
 304       if(i+1 >= argc) {
 305         print_usage(argv[0]);
 306         throw std::runtime_error("Need to specify a demo filename");
 307       }
 308       config->record_demo = argv[++i];
 309     } else if(arg == "-d") {
 310       config->enable_script_debugger = true;
 311     } else if(arg[0] != '-') {
 312       config->start_level = arg;
 313     } else {
 314       log_warning << "Unknown option '" << arg << "'. Use --help to see a list of options" << std::endl;
 315       return true;
 316     }
 317   }
 318
 319   return false;
 320 }
 321
 322 static void init_sdl()
 323 {
 324   if(SDL_Init(SDL_INIT_TIMER | SDL_INIT_VIDEO | SDL_INIT_JOYSTICK) < 0) {
 325     std::stringstream msg;
 326     msg << "Couldn't initialize SDL: " << SDL_GetError();
 327     throw std::runtime_error(msg.str());
 328   }
 329   // just to be sure
 330   atexit(SDL_Quit);
 331
 332   SDL_EnableUNICODE(1);
 333
 334   // wait 100ms and clear SDL event queue because sometimes we have random
 335   // joystick events in the queue on startup...
 336   SDL_Delay(100);
 337   SDL_Event dummy;
 338   while(SDL_PollEvent(&dummy))
 339       ;
 340 }
 341
 342 static void init_rand()
 343 {
 344   const char *how = config->random_seed? ", user fixed.": ", from time().";
 345
 346   config->random_seed = systemRandom.srand(config->random_seed);
 347
 348   log_info << "Using random seed " << config->random_seed << how << std::endl;
 349 }
 350
 351 void init_video()
 352 {
 353   if(texture_manager != NULL)
 354     texture_manager->save_textures();
 355
 356   SDL_GL_SetAttribute(SDL_GL_DOUBLEBUFFER, 1);
 357   SDL_GL_SetAttribute(SDL_GL_RED_SIZE, 5);
 358   SDL_GL_SetAttribute(SDL_GL_GREEN_SIZE, 5);
 359   SDL_GL_SetAttribute(SDL_GL_BLUE_SIZE, 5);
 360
 361   int flags = SDL_OPENGL;
 362   if(config->use_fullscreen)
 363     flags |= SDL_FULLSCREEN;
 364   int width = config->screenwidth;
 365   int height = config->screenheight;
 366   int bpp = 0;
 367
 368   screen = SDL_SetVideoMode(width, height, bpp, flags);
 369   if(screen == 0) {
 370     std::stringstream msg;
 371     msg << "Couldn't set video mode (" << width << "x" << height
 372         << "-" << bpp << "bpp): " << SDL_GetError();
 373     throw std::runtime_error(msg.str());
 374   }
 375
 376   SDL_WM_SetCaption(PACKAGE_NAME " " PACKAGE_VERSION, 0);
 377
 378   // set icon
 379   SDL_Surface* icon = IMG_Load_RW(
 380       get_physfs_SDLRWops("images/engine/icons/supertux.xpm"), true);
 381   if(icon != 0) {
 382     SDL_WM_SetIcon(icon, 0);
 383     SDL_FreeSurface(icon);
 384   }
 385 #ifdef DEBUG
 386   else {
 387     log_warning << "Couldn't find icon 'images/engine/icons/supertux.xpm'" << std::endl;
 388   }
 389 #endif
 390
 391   // use aspect ratio to calculate logical resolution
 392   if (config->aspectwidth > config->aspectheight) {
 393         SCREEN_HEIGHT=600;
 394         SCREEN_WIDTH=600*config->aspectwidth/config->aspectheight;
 395   }
 396   else {
 397         SCREEN_WIDTH=600;
 398         SCREEN_HEIGHT=600*config->aspectheight/config->aspectwidth;
 399   }
 400
 401   // setup opengl state and transform
 402   glDisable(GL_DEPTH_TEST);
 403   glDisable(GL_CULL_FACE);
 404   glEnable(GL_TEXTURE_2D);
 405   glEnable(GL_BLEND);
 406   glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
 407
 408   glViewport(0, 0, screen->w, screen->h);
 409   glMatrixMode(GL_PROJECTION);
 410   glLoadIdentity();
 411   // logical resolution here not real monitor resolution
 412   glOrtho(0, SCREEN_WIDTH, SCREEN_HEIGHT, 0, -1.0, 1.0);
 413   glMatrixMode(GL_MODELVIEW);
 414   glLoadIdentity();
 415   glTranslatef(0, 0, 0);
 416
 417   check_gl_error("Setting up view matrices");
 418
 419   if(texture_manager != NULL)
 420     texture_manager->reload_textures();
 421   else
 422     texture_manager = new TextureManager();
 423 }
 424
 425 static void init_audio()
 426 {
 427   sound_manager = new SoundManager();
 428
 429   sound_manager->enable_sound(config->sound_enabled);
 430   sound_manager->enable_music(config->music_enabled);
 431 }
 432
 433 static void quit_audio()
 434 {
 435   if(sound_manager != NULL) {
 436     delete sound_manager;
 437     sound_manager = NULL;
 438   }
 439 }
 440
 441 void wait_for_event(float min_delay, float max_delay)
 442 {
 443   assert(min_delay <= max_delay);
 444
 445   Uint32 min = (Uint32) (min_delay * 1000);
 446   Uint32 max = (Uint32) (max_delay * 1000);
 447
 448   Uint32 ticks = SDL_GetTicks();
 449   while(SDL_GetTicks() - ticks < min) {
 450     SDL_Delay(10);
 451     sound_manager->update();
 452   }
 453
 454   // clear event queue
 455   SDL_Event event;
 456   while (SDL_PollEvent(&event))
 457   {}
 458
 459   /* Handle events: */
 460   bool running = false;
 461   ticks = SDL_GetTicks();
 462   while(running) {
 463     while(SDL_PollEvent(&event)) {
 464       switch(event.type) {
 465         case SDL_QUIT:
 466           main_loop->quit();
 467           break;
 468         case SDL_KEYDOWN:
 469         case SDL_JOYBUTTONDOWN:
 470         case SDL_MOUSEBUTTONDOWN:
 471           running = false;
 472       }
 473     }
 474     if(SDL_GetTicks() - ticks >= (max - min))
 475       running = false;
 476     sound_manager->update();
 477     SDL_Delay(10);
 478   }
 479 }
 480
 481 #ifdef DEBUG
 482 static Uint32 last_timelog_ticks = 0;
 483 static const char* last_timelog_component = 0;
 484
 485 static inline void timelog(const char* component)
 486 {
 487   Uint32 current_ticks = SDL_GetTicks();
 488
 489   if(last_timelog_component != 0) {
 490     log_info << "Component '" << last_timelog_component <<  "' finished after " << (current_ticks - last_timelog_ticks) / 1000.0 << " seconds" << std::endl;
 491   }
 492
 493   last_timelog_ticks = current_ticks;
 494   last_timelog_component = component;
 495 }
 496 #else
 497 static inline void timelog(const char* )
 498 {
 499 }
 500 #endif
 501
 502 int main(int argc, char** argv)
 503 {
 504   int result = 0;
 505
 506   try {
 507
 508     if(pre_parse_commandline(argc, argv))
 509       return 0;
 510
 511     Console::instance = new Console();
 512     init_physfs(argv[0]);
 513     init_sdl();
 514
 515     timelog("controller");
 516     main_controller = new JoystickKeyboardController();
 517     timelog("config");
 518     init_config();
 519     timelog("tinygettext");
 520     init_tinygettext();
 521     timelog("commandline");
 522     if(parse_commandline(argc, argv))
 523       return 0;
 524     timelog("audio");
 525     init_audio();
 526     timelog("video");
 527     init_video();
 528     Console::instance->init_graphics();
 529     timelog("scripting");
 530     Scripting::init_squirrel(config->enable_script_debugger);
 531     timelog("resources");
 532     load_shared();
 533     timelog(0);
 534
 535     main_loop = new MainLoop();
 536     if(config->start_level != "") {
 537       // we have a normal path specified at commandline not physfs paths.
 538       // So we simply mount that path here...
 539       std::string dir = FileSystem::dirname(config->start_level);
 540       PHYSFS_addToSearchPath(dir.c_str(), true);
 541
 542       if(config->start_level.size() > 4 &&
 543               config->start_level.compare(config->start_level.size() - 5, 5, ".stwm") == 0) {
 544           init_rand();
 545           main_loop->push_screen(new WorldMapNS::WorldMap(
 546                       FileSystem::basename(config->start_level)));
 547       } else {
 548         init_rand();//If level uses random eg. for
 549         // rain particles before we do this:
 550         std::auto_ptr<GameSession> session (
 551                 new GameSession(FileSystem::basename(config->start_level)));
 552
 553         config->random_seed =session->get_demo_random_seed(config->start_demo);
 554         init_rand();//initialise generator with seed from session
 555
 556         if(config->start_demo != "")
 557           session->play_demo(config->start_demo);
 558
 559         if(config->record_demo != "")
 560           session->record_demo(config->record_demo);
 561         main_loop->push_screen(session.release());
 562       }
 563     } else {
 564       init_rand();
 565       main_loop->push_screen(new TitleScreen());
 566     }
 567
 568     //init_rand(); PAK: this call might subsume the above 3, but I'm chicken!
 569     main_loop->run();
 570   } catch(std::exception& e) {
 571     log_fatal << "Unexpected exception: " << e.what() << std::endl;
 572     result = 1;
 573   } catch(...) {
 574     log_fatal << "Unexpected exception" << std::endl;
 575     result = 1;
 576   }
 577
 578   delete main_loop;
 579   main_loop = NULL;
 580
 581   free_options_menu();
 582   unload_shared();
 583   quit_audio();
 584
 585   if(config)
 586     config->save();
 587   delete config;
 588   config = NULL;
 589   delete main_controller;
 590   main_controller = NULL;
 591   delete Console::instance;
 592   Console::instance = NULL;
 593   Scripting::exit_squirrel();
 594   delete texture_manager;
 595   texture_manager = NULL;
 596   SDL_Quit();
 597   PHYSFS_deinit();
 598
 599   return result;
 600 }