Changeset 5661

Timestamp:

Aug 19, 2009, 12:19:11 AM (15 years ago)

Author:

rgrieder

Message:

Cleaned out the lua script files for the GUI.
Also replaced "require" function to support resources.
Fixed a problem with the return value of doFile, includeFile and require being discarded because the tolua binding is for a C++ function returning void.

Location:

code/branches/resource2

Files:

• data/gui/layouts/MainMenu.layout (moved) (moved from code/branches/resource2/data/gui/layouts/MainMenu_2.layout) (6 diffs)
• data/gui/scripts/BasicGUI.lua (moved) (moved from code/branches/resource2/data/gui/scripts/gui.lua) (2 diffs)
• data/gui/scripts/IConsole.lua (deleted)
• data/gui/scripts/InitialiseGUI.lua (moved) (moved from code/branches/resource2/data/gui/scripts/loadGUI_3.lua) (1 diff)
• data/gui/scripts/InstancedInit.lua (deleted)
• data/gui/scripts/MainMenu.lua (moved) (moved from code/branches/resource2/data/gui/scripts/mainmenu_4.lua) (2 diffs)
• data/gui/scripts/PickupInventory.lua (modified) (2 diffs)
• data/gui/scripts/demo8.lua (deleted)
• data/gui/scripts/inGameTest.lua (deleted)
• data/gui/scripts/loadGUI.lua (deleted)
• data/gui/scripts/loadGUI_2.lua (deleted)
• data/gui/scripts/mainmenu.lua (deleted)
• data/gui/scripts/mainmenu_2.lua (deleted)
• data/gui/scripts/mainmenu_3.lua (deleted)
• data/lua/LuaStateInit.lua (modified) (3 diffs)
• src/core/GUIManager.cc (modified) (6 diffs)
• src/core/GUIManager.h (modified) (4 diffs)
• src/core/LuaState.cc (modified) (4 diffs)
• src/core/LuaState.h (modified) (1 diff)
• src/orxonox/gamestates/GSMainMenu.cc (modified) (1 diff)

code/branches/resource2/data/gui/layouts/MainMenu.layout

@@ -12 +12 @@
             <Property Name="Text" Value="Standalone"/>
             <Property Name="Disabled" Value="true"/>
-            <Event Name="Clicked" Function="mainmenu_2.button_standalone_clicked"/>
+            <Event Name="Clicked" Function="MainMenu.button_standalone_clicked"/>
         </Window>
         
@@ -20 +20 @@
             <Property Name="UnifiedSize" Value="{{0.35,0},{0.33,0}}" />
             <Property Name="Tooltip" Value="Available Levels." />
-            <Event Name="ItemSelectionChanged" Function="mainmenu_2.listbox_level_selectionchanged" />
+            <Event Name="ItemSelectionChanged" Function="MainMenu.listbox_level_selectionchanged" />
         </Window>
         
@@ -27 +27 @@
             <Property Name="UnifiedSize" Value="{{0.15,0},{0.05,0}}"/>
             <Property Name="Text" Value="Dedicated"/>
-            <Event Name="Clicked" Function="mainmenu_2.button_dedicated_clicked"/>
+            <Event Name="Clicked" Function="MainMenu.button_dedicated_clicked"/>
         </Window>
         
@@ -34 +34 @@
             <Property Name="UnifiedSize" Value="{{0.15,0},{0.05,0}}"/>
             <Property Name="Text" Value="Server"/>
-            <Event Name="Clicked" Function="mainmenu_2.button_server_clicked"/>
+            <Event Name="Clicked" Function="MainMenu.button_server_clicked"/>
         </Window>
         
@@ -41 +41 @@
             <Property Name="UnifiedSize" Value="{{0.15,0},{0.05,0}}"/>
             <Property Name="Text" Value="Client"/>
-            <Event Name="Clicked" Function="mainmenu_2.button_client_clicked"/>
+            <Event Name="Clicked" Function="MainMenu.button_client_clicked"/>
         </Window>
         
@@ -48 +48 @@
             <Property Name="UnifiedSize" Value="{{0.15,0},{0.05,0}}"/>
             <Property Name="Text" Value="Quit"/>
-            <Event Name="Clicked" Function="mainmenu_2.button_quit_clicked"/>
+            <Event Name="Clicked" Function="MainMenu.button_quit_clicked"/>
         </Window>
     </Window>

code/branches/resource2/data/gui/scripts/BasicGUI.lua

@@ -3 +3 @@
 local P = {}
 if _REQUIREDNAME == nil then
-    gui = P
+    BasicGUI = P
 else
     _G[_REQUIREDNAME] = P
@@ -40 +40 @@
 end
 
-return gui or _G[_REQUIREDNAME]
+return P

code/branches/resource2/data/gui/scripts/InitialiseGUI.lua

@@ -14 +14 @@
 
 loadedGUIs = {}
-
--- datapath is set before executing the script and points to media-folder
-package.path = package.path .. ";" .. datapath .. "gui/scripts/?.lua"
 
 -- loads the GUI with the specified filename

code/branches/resource2/data/gui/scripts/MainMenu.lua

@@ -1 @@
--- mainmenu_2.lua
-gui = require("gui")
-local P = gui:new() --inherit everything from the gui package
+-- MainMenu.lua
 
-mainmenu_2 = P
+BasicGUI = require("BasicGUI")
+local P = BasicGUI:new() --inherit everything from the gui package
+if _REQUIREDNAME == nil then
+    MainMenu = P
+else
+    _G[_REQUIREDNAME] = P
+end
 
-P.filename = "mainmenu_2"
-P.layoutString = "MainMenu_2.layout"
+P.filename = "MainMenu"
+P.layoutString = "MainMenu.layout"
 
 function P:init()
@@ -85 +89 @@
 end
 
-return mainmenu_2
+return P
 

code/branches/resource2/data/gui/scripts/PickupInventory.lua

@@ -1 @@
-gui = require("gui")
-local P = gui:new() --inherit everything from the gui package
+-- PickupInventory.lua
 
-PickupInventory = P
+BasicGUI = require("BasicGUI")
+local P = BasicGUI:new() --inherit everything from the gui package
+if _REQUIREDNAME == nil then
+    PickupInventory = P
+else
+    _G[_REQUIREDNAME] = P
+end
 
 P.filename = "PickupInventory"
@@ -61 +66 @@
 end
 
-return PickupInventory
+return P

code/branches/resource2/data/lua/LuaStateInit.lua

@@ -1 +1 @@
 -- Note: luaState is a pointer to the LuaState instance that created this lua state
 
--- Redirect debug to print
+-- Save original print function in debug
 debug = print
 
@@ -23 +23 @@
   resourceGroup = resourceGroup or "NoResourceGroupProvided"
   luaState:doFile(filename, resourceGroup, bSearchOtherPaths)
+  -- Required because the C++ function cannot return whatever might be on the stack
+  return LuaStateReturnValue
 end
+original_dofile = dofile
 dofile = doFile
 
@@ -33 +36 @@
   resourceGroup = resourceGroup or "NoResourceGroupProvided"
   luaState:includeFile(filename, resourceGroup, bSearchOtherPaths)
+  -- Required because the C++ function cannot return whatever might be on the stack
+  return LuaStateReturnValue
 end
+
+-- Replace require function with almost similar behaviour
+-- The difference is that you need to provide a resource group
+-- Default value there is the current one (if present) or else "General"
+-- But the loaded modules are then stored with only with the name (where name has no .lua extension)
+-- CAUTION: That also means that you need to take care of conflicting filenames among groups
+-- Furthermore the moduleName parameters is appended with the .lua extension when looking for the file
+old_require = require
+require = function(moduleName, resourceGroup)
+  local bSearchOtherPaths = (resourceGroup == nil) or false
+  resourceGroup = resourceGroup or "NoResourceGroupProvided"
+  if not luaState:fileExists(moduleName .. ".lua", resourceGroup, bSearchOtherPaths) then
+    return nil
+  end
+  if not _LOADED then
+    _LOADED = {}
+  end
+  if not _LOADED[moduleName] then
+    -- save old value
+    _REQUIREDNAME_OLD = _REQUIREDNAME
+    _REQUIREDNAME = moduleName
+    luaState:doFile(moduleName .. ".lua", resourceGroup, bSearchOtherPaths)
+    _LOADED[moduleName] = LuaStateReturnValue or true
+    -- restore old value
+    _REQUIREDNAME = _REQUIREDNAME_OLD
+  end
+  return _LOADED[moduleName]
+end

code/branches/resource2/src/core/GUIManager.cc

@@ -27 +27 @@
  *
  */
-
-/**
-@file
-@brief
-    Implementation of the GUIManager class.
-*/
 
 #include "GUIManager.h"
@@ -60 +54 @@
 #include "Clock.h"
 #include "LuaState.h"
+#include "Resource.h"
 
 namespace orxonox
@@ -115 +110 @@
 
         // setup scripting
-        scriptModule_.reset(new LuaScriptModule());
-        luaState_ = scriptModule_->getLuaState();
+        luaState_.reset(new LuaState());
+        scriptModule_.reset(new LuaScriptModule(luaState_->getInternalLuaState()));
 
         // Create our own logger to specify the filepath
@@ -129 +124 @@
         guiSystem_.reset(new System(guiRenderer_.get(), resourceProvider_, 0, scriptModule_.get()));
 
-        // do this after 'new CEGUI::Sytem' because that creates the lua state in the first place
-        LuaState::openToluaInterfaces(this->luaState_);
-
-        // initialise the basic lua code
-        this->loadLuaCode();
-    }
-
-    /**
-    @brief
-        Destructor of the GUIManager
-
+        // Initialise the basic lua code
+        rootFileInfo_ = Resource::getInfo("InitialiseGUI.lua", "GUI");
+        this->luaState_->doFile("InitialiseGUI.lua", "GUI", false);
+    }
+
+    /**
+    @brief
         Basically shuts down CEGUI (member smart pointers) but first unloads our Tolua modules.
     */
     GUIManager::~GUIManager()
     {
-        // destroy our own tolua interfaces
-        LuaState::closeToluaInterfaces(this->luaState_);
-    }
-
-    /**
-    @brief
-        Calls main Lua script
-    @todo
-        This function calls the main Lua script for our GUI.
-
-        Additionally we set the datapath variable in Lua. This is needed so Lua can access the data used for the GUI.
-    */
-    void GUIManager::loadLuaCode()
-    {
-        // set datapath for GUI data
-        lua_pushfstring(this->scriptModule_->getLuaState(), Core::getDataPathString().c_str());
-        lua_setglobal(this->scriptModule_->getLuaState(), "datapath");
-        // call main Lua script
-        this->scriptModule_->executeScriptFile("loadGUI_3.lua", "GUI");
     }
 
@@ -209 +181 @@
     void GUIManager::executeCode(const std::string& str)
     {
-        try
-        {
-            this->scriptModule_->executeString(str);
-        }
-        catch (const CEGUI::Exception& ex)
-        {
-            COUT(2) << "CEGUI Error: \"" << ex.getMessage() << "\" while executing code \"" << str << "\"" << std::endl;
-        }
-        catch (...)
-        {
-            COUT(2) << "Couldn't execute GUI related Lua code due to unknown reasons." << std::endl;
-        }
+        this->luaState_->doString(str, rootFileInfo_);
     }
 
@@ -234 +195 @@
     void GUIManager::showGUI(const std::string& name)
     {
-        this->executeCode(std::string("showGUI(\"") + name + "\")");
+        this->luaState_->doString("showGUI(\"" + name + "\")", rootFileInfo_);
     }
 

code/branches/resource2/src/core/GUIManager.h

@@ -28 +28 @@
  */
 
-/**
-@file
-@brief
-    Declaration of the GUIManager class.
-*/
-
 #ifndef _GUIManager_H__
 #define _GUIManager_H__
@@ -43 +37 @@
 #include <CEGUIForwardRefs.h>
 #include <boost/scoped_ptr.hpp>
+#include <boost/shared_ptr.hpp>
 
 #include "util/OgreForwardRefs.h"
@@ -80 +75 @@
         GUIManager(const GUIManager& instance); //!< private and undefined copy c'tor (this is a singleton class)
 
-        void loadLuaCode();
-
         // keyHandler functions
         void keyPressed (const KeyEvent& evt);
@@ -93 +86 @@
 
         scoped_ptr<CEGUI::OgreCEGUIRenderer> guiRenderer_;  //!< CEGUI's interface to the Ogre Engine
+        scoped_ptr<LuaState>                 luaState_;     //!< LuaState, access point to the Lua engine
         scoped_ptr<CEGUI::LuaScriptModule>   scriptModule_; //!< CEGUI's script module to use Lua
         scoped_ptr<CEGUI::System>            guiSystem_;    //!< CEGUI's main system
+        shared_ptr<ResourceInfo>             rootFileInfo_; //!< Resource information about the root script
         Ogre::RenderWindow*      renderWindow_;     //!< Ogre's render window to give CEGUI access to it
         CEGUI::ResourceProvider* resourceProvider_; //!< CEGUI's resource provider
         CEGUI::Logger*           ceguiLogger_;      //!< CEGUI's logger to be able to log CEGUI errors in our log
-        lua_State*               luaState_;         //!< Lua state, access point to the Lua engine
 
         static GUIManager*       singletonPtr_s;    //!< Singleton reference to GUIManager

code/branches/resource2/src/core/LuaState.cc

@@ -147 +147 @@
             sourceFileInfo_ = sourceFileInfo;
 
-        //if (!bIsRunning_)
-        //{
-        //    bIsRunning_ = true;
-
         int error = 0;
 #if LUA_VERSION_NUM != 501
@@ -163 +159 @@
         // execute the chunk
         if (error == 0)
-            error = lua_pcall(luaState_, 0, 0, 0);
+            error = lua_pcall(luaState_, 0, 1, 0);
         if (error != 0)
         {
@@ -170 +166 @@
                 origin = " originating from " + sourceFileInfo_->filename;
             COUT(2) << "Error in Lua-script" << origin << ": " << lua_tostring(luaState_, -1) << std::endl;
-        }
-
-        //    bIsRunning_ = false;
-        //}
-        //else
-        //{
-        //    COUT(2) << "Warning: LuaState do function called while running!" << std::endl;
-        //}
+            // return value is nil
+            lua_pushnil(luaState_);
+        }
+        // push return value because it will get lost since the return value of this function is void
+        lua_setglobal(luaState_, "LuaStateReturnValue");
 
         // Load the old info again
@@ -191 +184 @@
     {
         OutputHandler::getOutStream().setOutputLevel(level) << message << std::endl;
+    }
+
+    bool LuaState::fileExists(const std::string& filename, const std::string& resourceGroup, bool bSearchOtherPaths)
+    {
+        shared_ptr<ResourceInfo> info =  this->getFileInfo(filename, resourceGroup, bSearchOtherPaths);
+        if (info == NULL)
+            return false;
+        else
+            return true;
     }
 

code/branches/resource2/src/core/LuaState.h

@@ -59 +59 @@
         void doString(const std::string& code, shared_ptr<ResourceInfo> sourceFileInfo = shared_ptr<ResourceInfo>());
 
-        void includeFile(const std::string& filename, const std::string& resourceGroup = "Genreal", bool bSearchOtherPaths = true); // tolua_export
+        void includeFile(const std::string& filename, const std::string& resourceGroup = "General", bool bSearchOtherPaths = true); // tolua_export
         void includeString(const std::string& code, shared_ptr<ResourceInfo> sourceFileInfo = shared_ptr<ResourceInfo>());
 
         void luaPrint(const std::string& str); // tolua_export
         void luaLog(unsigned int level, const std::string& message); // tolua_export
+        bool fileExists(const std::string& filename, const std::string& resourceGroup = "General", bool bSearchOtherPaths = true); // tolua_export
 
         const std::stringstream& getOutput() const { return output_; }

code/branches/resource2/src/orxonox/gamestates/GSMainMenu.cc

@@ -70 +70 @@
     {
         // show main menu
-        GUIManager::getInstance().showGUI("mainmenu_4");
+        GUIManager::getInstance().showGUI("MainMenu");
         GUIManager::getInstance().setCamera(this->camera_);
         GraphicsManager::getInstance().setCamera(this->camera_);