Env.h

Go to the documentation of this file.

// Env.h
//
// Copyright (c) 2010, 2014, 2016 Michael Imamura.
//
// Licensed under GrokkSoft HoverRace SourceCode License v1.0(the "License");
// you may not use this file except in compliance with the License.
//
// A copy of the license should have been attached to the package from which
// you have taken this file. If you can not find the license you can not use
// this file.
//
//
// The author makes no representations about the suitability of
// this software for any purpose.  It is provided "as is" "AS IS",
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied.
//
// See the License for the specific language governing permissions
// and limitations under the License.

#pragma once

#include "../Util/OS.h"

#include "Core.h"
#include "RegistryRef.h"

#if defined(_WIN32) && defined(HR_ENGINE_SHARED)
#   ifdef MR_ENGINE
#       define MR_DllDeclare   __declspec( dllexport )
#   else
#       define MR_DllDeclare   __declspec( dllimport )
#   endif
#else
#   define MR_DllDeclare
#endif

namespace HoverRace {
    namespace Script {
        namespace Help {
            class HelpHandler;
        }
    }
}

namespace HoverRace {
namespace Script {

class MR_DllDeclare Env
{
public:
    Env(Core &scripting);
    Env(const Env&) = delete;
    virtual ~Env() { }

    Env &operator=(const Env&) = delete;

protected:
    Core &GetScripting() const { return scripting; }
    lua_State *GetState() const { return scripting.GetState(); }

    void LogScriptError(const Script::ScriptExn &ex);

    virtual void InitEnv() = 0;
    void CopyGlobals();

    void SetHelpHandler(Help::HelpHandler *helpHandler);

protected:
    void PushEnv();
private:
    void SetupEnv();

protected:
    template<class ReturnPolicy = Core::PrintReturn>
    int Execute(const Core::Chunk &chunk, ReturnPolicy rp = ReturnPolicy())
    {
        // May throw ScriptExn or IncompleteExn, in which case the stack
        // will be unchanged.
        scripting.Compile(chunk);

        SetupEnv();

        // May throw ScriptExn, but the function on the stack will be
        // consumed anyway.
        return scripting.Invoke(0, helpHandler, rp);
    }

protected:
    static Core::Chunk LoadChunkFromFile(const Util::OS::path_t &filename);

public:
    bool RunScript(const Util::OS::path_t &filename)
    {
        try {
            Execute(LoadChunkFromFile(filename));
            return true;
        }
        catch (Script::ScriptExn &ex) {
            LogScriptError(ex);
            return false;
        }
    }

private:
    Core &scripting;
    bool initialized;
    RegistryRef envRef;
    Help::HelpHandler *helpHandler;
};

}  // namespace Script
}  // namespace HoverRace

#undef MR_DllDeclare