LuaWrapper.h

#pragma once
 
#include <Core/CoreDLL.h>
#include <Foundation/Logging/Log.h>
#include <Foundation/Strings/String.h>
 
#ifdef BUILDSYSTEM_ENABLE_LUA_SUPPORT
 
#  if PL_ENABLED(PL_PLATFORM_WINDOWS_UWP)
// We compile Lua as C++ under UWP so we need to include the headers directly
// to prevent the addition of extern "C" done by lua.hpp.
#    include <Lua/lauxlib.h>
#    include <Lua/lua.h>
#    include <Lua/luaconf.h>
#    include <Lua/lualib.h>
#  else
#    include <Lua/lua.hpp>
#  endif
 
class PL_CORE_DLL plLuaWrapper
{
  PL_DISALLOW_COPY_AND_ASSIGN(plLuaWrapper);
 
public:
 
  plLuaWrapper(); // [tested]
 
  plLuaWrapper(lua_State* s);
 
  ~plLuaWrapper(); // [tested]
 
  void Clear(); // [tested]
 
  lua_State* GetLuaState();
 
  plResult ExecuteString(const char* szString, const char* szDebugChunkName = "chunk",
    plLogInterface* pLogInterface = nullptr) const; // [tested]
 
 
 
 
  plResult OpenTable(const char* szTable); // [tested]
 
  plResult OpenTableFromParameter(plUInt32 uiFunctionParameter); // [tested]
 
  void CloseTable(); // [tested]
 
  void CloseAllTables(); // [tested]
 
  void PushTable(const char* szTableName, bool bGlobalTable); // [tested]
 
 
 
  bool IsVariableAvailable(const char* szVariable) const; // [tested]
 
  bool IsFunctionAvailable(const char* szFunction) const; // [tested]
 
 
 
  int GetIntVariable(const char* szName, plInt32 iDefault = 0) const; // [tested]
 
  bool GetBoolVariable(const char* szName, bool bDefault = false) const; // [tested]
 
  float GetFloatVariable(const char* szName, float fDefault = 0.0f) const; // [tested]
 
  const char* GetStringVariable(const char* szName, const char* szDefault = "") const; // [tested]
 
 
 
  void SetVariableNil(const char* szName) const; // [tested]
 
  void SetVariable(const char* szName, plInt32 iValue) const; // [tested]
 
  void SetVariable(const char* szName, bool bValue) const; // [tested]
 
  void SetVariable(const char* szName, float fValue) const; // [tested]
 
  void SetVariable(const char* szName, const char* szValue) const; // [tested]
 
  void SetVariable(const char* szName, const char* szValue, plUInt32 uiLen) const; // [tested]
 
 
 
  void RegisterCFunction(const char* szFunctionName, lua_CFunction function, void* pLightUserData = nullptr) const; // [tested]
 
  bool PrepareFunctionCall(const char* szFunctionName); // [tested]
 
  plResult CallPreparedFunction(plUInt32 uiExpectedReturnValues = 0, plLogInterface* pLogInterface = nullptr); // [tested]
 
  void DiscardReturnValues(); // [tested]
 
  plInt32 ReturnToScript() const; // [tested]
 
 
 
  void PushParameter(plInt32 iParam); // [tested]
 
  void PushParameter(bool bParam); // [tested]
 
  void PushParameter(float fParam); // [tested]
 
  void PushParameter(const char* szParam); // [tested]
 
  void PushParameter(const char* szParam, plUInt32 uiLength); // [tested]
 
  void PushParameterNil(); // [tested]
 
 
 
  void* GetFunctionLightUserData() const;
 
  plUInt32 GetNumberOfFunctionParameters() const; // [tested]
 
  bool IsParameterInt(plUInt32 uiParameter) const; // [tested]
 
  bool IsParameterBool(plUInt32 uiParameter) const; // [tested]
 
  bool IsParameterFloat(plUInt32 uiParameter) const; // [tested]
 
  bool IsParameterTable(plUInt32 uiParameter) const; // [tested]
 
  bool IsParameterString(plUInt32 uiParameter) const; // [tested]
 
  bool IsParameterNil(plUInt32 uiParameter) const; // [tested]
 
  int GetIntParameter(plUInt32 uiParameter) const; // [tested]
 
  bool GetBoolParameter(plUInt32 uiParameter) const; // [tested]
 
  float GetFloatParameter(plUInt32 uiParameter) const; // [tested]
 
  const char* GetStringParameter(plUInt32 uiParameter) const; // [tested]
 
 
 
  void PushReturnValue(plInt32 iParam); // [tested]
 
  void PushReturnValue(bool bParam); // [tested]
 
  void PushReturnValue(float fParam); // [tested]
 
  void PushReturnValue(const char* szParam); // [tested]
 
  void PushReturnValue(const char* szParam, plUInt32 uiLength); // [tested]
 
  void PushReturnValueNil(); // [tested]
 
 
  bool IsReturnValueInt(plUInt32 uiReturnValue) const; // [tested]
 
  bool IsReturnValueBool(plUInt32 uiReturnValue) const; // [tested]
 
  bool IsReturnValueFloat(plUInt32 uiReturnValue) const; // [tested]
 
  bool IsReturnValueString(plUInt32 uiReturnValue) const; // [tested]
 
  bool IsReturnValueNil(plUInt32 uiReturnValue) const; // [tested]
 
 
  int GetIntReturnValue(plUInt32 uiReturnValue) const; // [tested]
 
  bool GetBoolReturnValue(plUInt32 uiReturnValue) const; // [tested]
 
  float GetFloatReturnValue(plUInt32 uiReturnValue) const; // [tested]
 
  const char* GetStringReturnValue(plUInt32 uiReturnValue) const; // [tested]
 
 
 
private:
  static void* lua_allocator(void* ud, void* ptr, size_t osize, size_t nsize);
 
  lua_State* m_pState;
 
  bool m_bReleaseOnExit;
 
  struct plScriptStates
  {
    plScriptStates()
 
      = default;
 
    plInt32 m_iParametersPushed = 0;
 
    plInt32 m_iOpenTables = 0;
 
    plInt32 m_iLuaReturnValues = 0;
  };
 
  plScriptStates m_States;
 
  static constexpr plInt32 s_iParamOffset = 1; // should be one, to start counting at 0, instead of 1
};
 
#  include <Core/Scripting/LuaWrapper/LuaWrapper.inl>
 
#endif // BUILDSYSTEM_ENABLE_LUA_SUPPORT