src/guiEngine.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2013 sapier
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 extern "C" {
  21 #include "lua.h"
  22 #include "lauxlib.h"
  23 #include "lualib.h"
  24 }
  25
  26 #include "irrlicht.h"
  27
  28 #include "porting.h"
  29 #include "filesys.h"
  30 #include "main.h"
  31 #include "settings.h"
  32 #include "guiMainMenu.h"
  33 #include "sound.h"
  34 #include "sound_openal.h"
  35
  36 #include "guiEngine.h"
  37
  38 #if USE_CURL
  39 #include <curl/curl.h>
  40 #endif
  41
  42 /******************************************************************************/
  43 int menuscript_ErrorHandler(lua_State *L) {
  44         lua_getfield(L, LUA_GLOBALSINDEX, "debug");
  45         if (!lua_istable(L, -1)) {
  46         lua_pop(L, 1);
  47         return 1;
  48         }
  49         lua_getfield(L, -1, "traceback");
  50         if (!lua_isfunction(L, -1)) {
  51         lua_pop(L, 2);
  52         return 1;
  53         }
  54         lua_pushvalue(L, 1);
  55         lua_pushinteger(L, 2);
  56         lua_call(L, 2, 1);
  57         return 1;
  58 }
  59
  60 /******************************************************************************/
  61 TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
  62 {
  63         m_engine = engine;
  64 }
  65
  66 /******************************************************************************/
  67 void TextDestGuiEngine::gotText(std::map<std::string, std::string> fields)
  68 {
  69         m_engine->handleButtons(fields);
  70 }
  71
  72 /******************************************************************************/
  73 void TextDestGuiEngine::gotText(std::wstring text)
  74 {
  75         m_engine->handleEvent(wide_to_narrow(text));
  76 }
  77
  78 /******************************************************************************/
  79 GUIEngine::GUIEngine(   irr::IrrlichtDevice* dev,
  80                                                 gui::IGUIElement* parent,
  81                                                 IMenuManager *menumgr,
  82                                                 scene::ISceneManager* smgr,
  83                                                 MainMenuData* data) :
  84         m_device(dev),
  85         m_parent(parent),
  86         m_menumanager(menumgr),
  87         m_smgr(smgr),
  88         m_data(data),
  89         m_sound_manager(NULL),
  90         m_formspecgui(0),
  91         m_buttonhandler(0),
  92         m_menu(0),
  93         m_startgame(false),
  94         m_engineluastack(0),
  95         m_luaerrorhandler(-1),
  96         m_scriptdir(""),
  97         m_irr_toplefttext(0),
  98         m_clouds_enabled(true),
  99         m_cloud()
 100 {
 101         //initialize texture pointers
 102         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 103                 m_textures[i] = 0;
 104         }
 105         // is deleted by guiformspec!
 106         m_buttonhandler = new TextDestGuiEngine(this);
 107
 108         //create luastack
 109         m_engineluastack = luaL_newstate();
 110
 111         //load basic lua modules
 112         luaL_openlibs(m_engineluastack);
 113
 114         //init
 115         guiLuaApi::initialize(m_engineluastack,this);
 116
 117         //push errorstring
 118         if (m_data->errormessage != "")
 119         {
 120                 lua_getglobal(m_engineluastack, "gamedata");
 121                 int gamedata_idx = lua_gettop(m_engineluastack);
 122                 lua_pushstring(m_engineluastack, "errormessage");
 123                 lua_pushstring(m_engineluastack,m_data->errormessage.c_str());
 124                 lua_settable(m_engineluastack, gamedata_idx);
 125                 m_data->errormessage = "";
 126         }
 127
 128         //create soundmanager
 129         MenuMusicFetcher soundfetcher;
 130 #if USE_SOUND
 131         m_sound_manager = createOpenALSoundManager(&soundfetcher);
 132 #endif
 133         if(!m_sound_manager)
 134                 m_sound_manager = &dummySoundManager;
 135
 136         //create topleft header
 137         core::rect<s32> rect(0, 0, 500, 40);
 138         rect += v2s32(4, 0);
 139         std::string t = "Minetest " VERSION_STRING;
 140
 141         m_irr_toplefttext =
 142                 m_device->getGUIEnvironment()->addStaticText(narrow_to_wide(t).c_str(),
 143                 rect,false,true,0,-1);
 144
 145         //create formspecsource
 146         m_formspecgui = new FormspecFormSource("",&m_formspecgui);
 147
 148         /* Create menu */
 149         m_menu =
 150                 new GUIFormSpecMenu(    m_device,
 151                                                                 m_parent,
 152                                                                 -1,
 153                                                                 m_menumanager,
 154                                                                 0 /* &client */,
 155                                                                 0 /* gamedef */);
 156
 157         m_menu->allowClose(false);
 158         m_menu->lockSize(true,v2u32(800,600));
 159         m_menu->setFormSource(m_formspecgui);
 160         m_menu->setTextDest(m_buttonhandler);
 161         m_menu->useGettext(true);
 162
 163         std::string builtin_helpers
 164                 = porting::path_share + DIR_DELIM + "builtin"
 165                         + DIR_DELIM + "misc_helpers.lua";
 166
 167         if (!runScript(builtin_helpers)) {
 168                 errorstream
 169                         << "GUIEngine::GUIEngine unable to load builtin helper script"
 170                         << std::endl;
 171                 return;
 172         }
 173
 174         std::string menuscript = "";
 175         if (g_settings->exists("main_menu_script"))
 176                 menuscript = g_settings->get("main_menu_script");
 177         std::string builtin_menuscript =
 178                         porting::path_share + DIR_DELIM + "builtin"
 179                                 + DIR_DELIM + "mainmenu.lua";
 180
 181         lua_pushcfunction(m_engineluastack, menuscript_ErrorHandler);
 182         m_luaerrorhandler = lua_gettop(m_engineluastack);
 183
 184         m_scriptdir = menuscript.substr(0,menuscript.find_last_of(DIR_DELIM)-1);
 185         if((menuscript == "") || (!runScript(menuscript))) {
 186                 infostream
 187                         << "GUIEngine::GUIEngine execution of custom menu failed!"
 188                         << std::endl
 189                         << "\tfalling back to builtin menu"
 190                         << std::endl;
 191                 m_scriptdir = fs::RemoveRelativePathComponents(porting::path_share + DIR_DELIM + "builtin"+ DIR_DELIM);
 192                 if(!runScript(builtin_menuscript)) {
 193                         errorstream
 194                                 << "GUIEngine::GUIEngine unable to load builtin menu"
 195                                 << std::endl;
 196                         assert("no future without mainmenu" == 0);
 197                 }
 198         }
 199
 200         run();
 201
 202         m_menumanager->deletingMenu(m_menu);
 203         m_menu->drop();
 204         m_menu = 0;
 205 }
 206
 207 /******************************************************************************/
 208 bool GUIEngine::runScript(std::string script) {
 209
 210         int ret =       luaL_loadfile(m_engineluastack, script.c_str()) ||
 211                                 lua_pcall(m_engineluastack, 0, 0, m_luaerrorhandler);
 212         if(ret){
 213                 errorstream<<"========== ERROR FROM LUA WHILE CREATING MAIN MENU ==========="<<std::endl;
 214                 errorstream<<"Failed to load and run script from "<<std::endl;
 215                 errorstream<<script<<":"<<std::endl;
 216                 errorstream<<std::endl;
 217                 errorstream<<lua_tostring(m_engineluastack, -1)<<std::endl;
 218                 errorstream<<std::endl;
 219                 errorstream<<"=================== END OF ERROR FROM LUA ===================="<<std::endl;
 220                 lua_pop(m_engineluastack, 1); // Pop error message from stack
 221                 lua_pop(m_engineluastack, 1); // Pop the error handler from stack
 222                 return false;
 223         }
 224         return true;
 225 }
 226
 227 /******************************************************************************/
 228 void GUIEngine::run()
 229 {
 230
 231         // Always create clouds because they may or may not be
 232         // needed based on the game selected
 233         video::IVideoDriver* driver = m_device->getVideoDriver();
 234
 235         cloudInit();
 236
 237         while(m_device->run() && (!m_startgame)) {
 238                 driver->beginScene(true, true, video::SColor(255,140,186,250));
 239
 240                 if (m_clouds_enabled)
 241                 {
 242                         cloudPreProcess();
 243                         drawOverlay(driver);
 244                 }
 245                 else
 246                         drawBackground(driver);
 247
 248                 drawHeader(driver);
 249                 drawFooter(driver);
 250
 251                 m_device->getGUIEnvironment()->drawAll();
 252
 253                 driver->endScene();
 254
 255                 if (m_clouds_enabled)
 256                         cloudPostProcess();
 257                 else
 258                         sleep_ms(25);
 259         }
 260
 261         m_menu->quitMenu();
 262 }
 263
 264 /******************************************************************************/
 265 void GUIEngine::handleEvent(std::string text)
 266 {
 267         lua_getglobal(m_engineluastack, "engine");
 268
 269         lua_getfield(m_engineluastack, -1, "event_handler");
 270
 271         if(lua_isnil(m_engineluastack, -1))
 272                 return;
 273
 274         luaL_checktype(m_engineluastack, -1, LUA_TFUNCTION);
 275
 276         lua_pushstring(m_engineluastack, text.c_str());
 277
 278         if(lua_pcall(m_engineluastack, 1, 0, m_luaerrorhandler))
 279                 scriptError("error: %s", lua_tostring(m_engineluastack, -1));
 280 }
 281
 282 /******************************************************************************/
 283 void GUIEngine::handleButtons(std::map<std::string, std::string> fields)
 284 {
 285         lua_getglobal(m_engineluastack, "engine");
 286
 287         lua_getfield(m_engineluastack, -1, "button_handler");
 288
 289         if(lua_isnil(m_engineluastack, -1))
 290                 return;
 291
 292         luaL_checktype(m_engineluastack, -1, LUA_TFUNCTION);
 293
 294         lua_newtable(m_engineluastack);
 295         for(std::map<std::string, std::string>::const_iterator
 296                 i = fields.begin(); i != fields.end(); i++){
 297                 const std::string &name = i->first;
 298                 const std::string &value = i->second;
 299                 lua_pushstring(m_engineluastack, name.c_str());
 300                 lua_pushlstring(m_engineluastack, value.c_str(), value.size());
 301                 lua_settable(m_engineluastack, -3);
 302         }
 303
 304         if(lua_pcall(m_engineluastack, 1, 0, m_luaerrorhandler))
 305                 scriptError("error: %s", lua_tostring(m_engineluastack, -1));
 306 }
 307
 308 /******************************************************************************/
 309 GUIEngine::~GUIEngine()
 310 {
 311         video::IVideoDriver* driver = m_device->getVideoDriver();
 312         assert(driver != 0);
 313
 314         if(m_sound_manager != &dummySoundManager){
 315                 delete m_sound_manager;
 316                 m_sound_manager = NULL;
 317         }
 318
 319         //TODO: clean up m_menu here
 320
 321         lua_close(m_engineluastack);
 322
 323         m_irr_toplefttext->setText(L"");
 324
 325         //initialize texture pointers
 326         for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
 327                 if (m_textures[i] != 0)
 328                         driver->removeTexture(m_textures[i]);
 329         }
 330
 331         if (m_cloud.clouds)
 332                 m_cloud.clouds->drop();
 333 }
 334
 335 /******************************************************************************/
 336 void GUIEngine::cloudInit()
 337 {
 338         m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
 339                         m_smgr, -1, rand(), 100);
 340         m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
 341
 342         m_cloud.camera = m_smgr->addCameraSceneNode(0,
 343                                 v3f(0,0,0), v3f(0, 60, 100));
 344         m_cloud.camera->setFarValue(10000);
 345
 346         m_cloud.lasttime = m_device->getTimer()->getTime();
 347 }
 348
 349 /******************************************************************************/
 350 void GUIEngine::cloudPreProcess()
 351 {
 352         u32 time = m_device->getTimer()->getTime();
 353
 354         if(time > m_cloud.lasttime)
 355                 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
 356         else
 357                 m_cloud.dtime = 0;
 358
 359         m_cloud.lasttime = time;
 360
 361         m_cloud.clouds->step(m_cloud.dtime*3);
 362         m_cloud.clouds->render();
 363         m_smgr->drawAll();
 364 }
 365
 366 /******************************************************************************/
 367 void GUIEngine::cloudPostProcess()
 368 {
 369         float fps_max = g_settings->getFloat("fps_max");
 370         // Time of frame without fps limit
 371         float busytime;
 372         u32 busytime_u32;
 373         // not using getRealTime is necessary for wine
 374         u32 time = m_device->getTimer()->getTime();
 375         if(time > m_cloud.lasttime)
 376                 busytime_u32 = time - m_cloud.lasttime;
 377         else
 378                 busytime_u32 = 0;
 379         busytime = busytime_u32 / 1000.0;
 380
 381         // FPS limiter
 382         u32 frametime_min = 1000./fps_max;
 383
 384         if(busytime_u32 < frametime_min) {
 385                 u32 sleeptime = frametime_min - busytime_u32;
 386                 m_device->sleep(sleeptime);
 387         }
 388 }
 389
 390 /******************************************************************************/
 391 void GUIEngine::drawBackground(video::IVideoDriver* driver)
 392 {
 393         v2u32 screensize = driver->getScreenSize();
 394
 395         video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND];
 396
 397         /* If no texture, draw background of solid color */
 398         if(!texture){
 399                 video::SColor color(255,80,58,37);
 400                 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
 401                 driver->draw2DRectangle(color, rect, NULL);
 402                 return;
 403         }
 404
 405         /* Draw background texture */
 406         v2u32 sourcesize = texture->getSize();
 407         driver->draw2DImage(texture,
 408                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 409                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 410                 NULL, NULL, true);
 411 }
 412
 413 /******************************************************************************/
 414 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
 415 {
 416         v2u32 screensize = driver->getScreenSize();
 417
 418         video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY];
 419
 420         /* If no texture, draw background of solid color */
 421         if(!texture)
 422                 return;
 423
 424         /* Draw background texture */
 425         v2u32 sourcesize = texture->getSize();
 426         driver->draw2DImage(texture,
 427                 core::rect<s32>(0, 0, screensize.X, screensize.Y),
 428                 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
 429                 NULL, NULL, true);
 430 }
 431
 432 /******************************************************************************/
 433 void GUIEngine::drawHeader(video::IVideoDriver* driver)
 434 {
 435         core::dimension2d<u32> screensize = driver->getScreenSize();
 436
 437         video::ITexture* texture = m_textures[TEX_LAYER_HEADER];
 438
 439         /* If no texture, draw nothing */
 440         if(!texture)
 441                 return;
 442
 443         f32 mult = (((f32)screensize.Width / 2)) /
 444                         ((f32)texture->getOriginalSize().Width);
 445
 446         v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
 447                         ((f32)texture->getOriginalSize().Height) * mult);
 448
 449         // Don't draw the header is there isn't enough room
 450         s32 free_space = (((s32)screensize.Height)-320)/2;
 451
 452         if (free_space > splashsize.Y) {
 453                 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
 454                 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
 455                                 ((free_space/2)-splashsize.Y/2)+10);
 456
 457         video::SColor bgcolor(255,50,50,50);
 458
 459         driver->draw2DImage(texture, splashrect,
 460                 core::rect<s32>(core::position2d<s32>(0,0),
 461                 core::dimension2di(texture->getSize())),
 462                 NULL, NULL, true);
 463         }
 464 }
 465
 466 /******************************************************************************/
 467 void GUIEngine::drawFooter(video::IVideoDriver* driver)
 468 {
 469         core::dimension2d<u32> screensize = driver->getScreenSize();
 470
 471         video::ITexture* texture = m_textures[TEX_LAYER_FOOTER];
 472
 473         /* If no texture, draw nothing */
 474         if(!texture)
 475                 return;
 476
 477         f32 mult = (((f32)screensize.Width)) /
 478                         ((f32)texture->getOriginalSize().Width);
 479
 480         v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
 481                         ((f32)texture->getOriginalSize().Height) * mult);
 482
 483         // Don't draw the footer if there isn't enough room
 484         s32 free_space = (((s32)screensize.Height)-320)/2;
 485
 486         if (free_space > footersize.Y) {
 487                 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
 488                 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
 489                 rect -= v2s32(footersize.X/2, 0);
 490
 491                 driver->draw2DImage(texture, rect,
 492                         core::rect<s32>(core::position2d<s32>(0,0),
 493                         core::dimension2di(texture->getSize())),
 494                         NULL, NULL, true);
 495         }
 496 }
 497
 498 /******************************************************************************/
 499 bool GUIEngine::setTexture(texture_layer layer,std::string texturepath) {
 500
 501         video::IVideoDriver* driver = m_device->getVideoDriver();
 502         assert(driver != 0);
 503
 504         if (m_textures[layer] != 0)
 505         {
 506                 driver->removeTexture(m_textures[layer]);
 507                 m_textures[layer] = 0;
 508         }
 509
 510         if ((texturepath == "") || !fs::PathExists(texturepath))
 511                 return false;
 512
 513         m_textures[layer] = driver->getTexture(texturepath.c_str());
 514
 515         if (m_textures[layer] == 0) return false;
 516
 517         return true;
 518 }
 519
 520 /******************************************************************************/
 521 #if USE_CURL
 522 static size_t WriteCallback(void *contents, size_t size, size_t nmemb, void *userp)
 523 {
 524         FILE* targetfile = (FILE*) userp;
 525         fwrite(contents,size,nmemb,targetfile);
 526         return size * nmemb;
 527 }
 528 #endif
 529 bool GUIEngine::downloadFile(std::string url,std::string target) {
 530 #if USE_CURL
 531         //download file via curl
 532         CURL *curl;
 533
 534         curl = curl_easy_init();
 535
 536         if (curl)
 537         {
 538                 CURLcode res;
 539                 bool retval = true;
 540
 541                 FILE* targetfile = fopen(target.c_str(),"wb");
 542
 543                 if (targetfile) {
 544                         curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
 545                         curl_easy_setopt(curl, CURLOPT_URL, url.c_str());
 546                         curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteCallback);
 547                         curl_easy_setopt(curl, CURLOPT_WRITEDATA, targetfile);
 548
 549                         res = curl_easy_perform(curl);
 550                         if (res != CURLE_OK) {
 551                                 errorstream << "File at url \"" << url
 552                                         <<"\" not found (" << curl_easy_strerror(res) << ")" <<std::endl;
 553                                 retval = false;
 554                         }
 555                         fclose(targetfile);
 556                 }
 557                 else {
 558                         retval = false;
 559                 }
 560
 561                 curl_easy_cleanup(curl);
 562                 return retval;
 563         }
 564 #endif
 565         return false;
 566 }
 567
 568 /******************************************************************************/
 569 void GUIEngine::scriptError(const char *fmt, ...)
 570 {
 571         va_list argp;
 572         va_start(argp, fmt);
 573         char buf[10000];
 574         vsnprintf(buf, 10000, fmt, argp);
 575         va_end(argp);
 576         errorstream<<"MAINMENU ERROR: "<<buf;
 577 }
 578
 579 /******************************************************************************/
 580 void GUIEngine::setTopleftText(std::string append) {
 581         std::string toset = "Minetest " VERSION_STRING;
 582
 583         if (append != "") {
 584                 toset += " / ";
 585                 toset += append;
 586         }
 587
 588         m_irr_toplefttext->setText(narrow_to_wide(toset).c_str());
 589 }
 590
 591 /******************************************************************************/
 592 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
 593 {
 594         s32 handle = m_sound_manager->playSound(spec, looped);
 595         return handle;
 596 }
 597
 598 /******************************************************************************/
 599 void GUIEngine::stopSound(s32 handle)
 600 {
 601         m_sound_manager->stopSound(handle);
 602 }