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