sol2/sol/state_view.hpp

// The MIT License (MIT) 

// Copyright (c) 2013-2016 Rapptz, ThePhD and contributors

// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#ifndef SOL_STATE_VIEW_HPP
#define SOL_STATE_VIEW_HPP

#include "error.hpp"
#include "table.hpp"
#include "load_result.hpp"
#include <memory>

namespace sol {
enum class lib : char {
    base,
    package,
    coroutine,
    string,
    os,
    math,
    table,
    debug,
    bit32,
    io,
    ffi,
    jit,
    count
};

class state_view {
private:
    lua_State* L;
    table reg;
    global_table global;

    template <typename T>
    void ensure_package(const std::string& key, T&& sr) {
        auto pkg = (*this)["package"];
        if (!pkg.valid()) {
            pkg = create_table_with("loaded", create_table_with(key, sr));
        }
	   else {
            auto ld = pkg["loaded"];
            if (!ld.valid()) {
                ld = create_table_with(key, sr);
            }
            else {
                ld[key] = sr;
            }
        }
    }

public:
    typedef global_table::iterator iterator;
    typedef global_table::const_iterator const_iterator;

    state_view(lua_State* L):
    L(L),
    reg(L, LUA_REGISTRYINDEX),
    global(L, detail::global_) {

    }

    lua_State* lua_state() const {
        return L;
    }

    template<typename... Args>
    void open_libraries(Args&&... args) {
        static_assert(meta::are_same<lib, Args...>::value, "all types must be libraries");
        if(sizeof...(args) == 0) {
            luaL_openlibs(L);
            return;
        }

        lib libraries[1 + sizeof...(args)] = { lib::count, std::forward<Args>(args)... };

        for(auto&& library : libraries) {
            switch(library) {
#if SOL_LUA_VERSION <= 501 && defined(SOL_LUAJIT)
            case lib::coroutine:
#endif // luajit opens coroutine base stuff
            case lib::base:
                luaL_requiref(L, "base", luaopen_base, 1);
                lua_pop(L, 1);
                break;
            case lib::package:
                luaL_requiref(L, "package", luaopen_package, 1);
                lua_pop(L, 1);
                break;
#if !defined(SOL_LUAJIT)
            case lib::coroutine:
#if SOL_LUA_VERSION > 501
                luaL_requiref(L, "coroutine", luaopen_coroutine, 1);
                lua_pop(L, 1);
#endif // Lua 5.2+ only
                break;
#endif // Not LuaJIT
            case lib::string:
                luaL_requiref(L, "string", luaopen_string, 1);
                lua_pop(L, 1);
                break;
            case lib::table:
                luaL_requiref(L, "table", luaopen_table, 1);
                lua_pop(L, 1);
                break;
            case lib::math:
                luaL_requiref(L, "math", luaopen_math, 1);
                lua_pop(L, 1);
                break;
            case lib::bit32:
#ifdef SOL_LUAJIT
                luaL_requiref(L, "bit32", luaopen_bit, 1);
                lua_pop(L, 1);
#elif SOL_LUA_VERSION == 502
                luaL_requiref(L, "bit32", luaopen_bit32, 1);
                lua_pop(L, 1);
#else
#endif // Lua 5.2 only (deprecated in 5.3 (503))
                break;
            case lib::io:
                luaL_requiref(L, "io", luaopen_io, 1);
                lua_pop(L, 1);
                break;
            case lib::os:
                luaL_requiref(L, "os", luaopen_os, 1);
                lua_pop(L, 1);
                break;
            case lib::debug:
                luaL_requiref(L, "debug", luaopen_debug, 1);
                lua_pop(L, 1);
                break;
            case lib::ffi:
#ifdef SOL_LUAJIT
                luaL_requiref(L, "ffi", luaopen_ffi, 1);
                lua_pop(L, 1);
#endif
                break;
            case lib::jit:
#ifdef SOL_LUAJIT
                luaL_requiref(L, "jit", luaopen_jit, 1);
                lua_pop(L, 1);
#endif
                break;
            case lib::count:
            default:
                break;
            }
        }
    }

    template <typename Fx>
    object require(const std::string& key, Fx&& open_function, bool is_global_library = true) {
        auto openfx = [fx = std::forward<Fx>(open_function)](lua_State* L){ 
            typedef lua_bind_traits<meta::unqualified_t<Fx>> traits;
            return stack::call(typename traits::return_type(), typename traits::args_type(), L, fx); 
        };
        stack::push(L, function_args<function_sig<>>(std::forward<Fx>(openfx)));
	   lua_CFunction openf = stack::pop<lua_CFunction>(L);
        luaL_requiref(L, key.c_str(), openf, is_global_library ? 1 : 0);
        object r stack::pop<object>(L);
	   lua_pop(L, 1);
	   return r;
    }

    object require_script(const std::string& key, const std::string& code) {
        optional<object> loaded = traverse_get<optional<object>>("package", "loaded", key);
        bool ismod = loaded && !(loaded->is<bool>() && !loaded->as<bool>());
        if (ismod)
            return std::move(*loaded);
        script(code);
        auto sr = stack::get<stack_reference>(L);
        set(key, sr);
        ensure_package(key, sr);
	   return stack::pop<object>(L);
    }

    object require_file(const std::string& key, const std::string& file) {
        auto loaded = traverse_get<optional<object>>("package", "loaded", key);
        bool ismod = loaded && !(loaded->is<bool>() && !loaded->as<bool>());
        if (loaded)
            return std::move(*loaded);
        script_file(file);
        auto sr = stack::get<stack_reference>(L);
        set(key, sr);
        ensure_package(key, sr);
	   return stack::pop<object>(L);
    }

    void script(const std::string& code) {
        if(luaL_dostring(L, code.c_str())) {
            lua_error(L);
        }
    }

    void script_file(const std::string& filename) {
        if(luaL_dofile(L, filename.c_str())) {
            lua_error(L);
        }
    }

    load_result load(const std::string& code) {
        load_status x = static_cast<load_status>(luaL_loadstring(L, code.c_str()));
        return load_result(L, -1, 1, 1, x);
    }

    load_result load_file(const std::string& filename) {
        load_status x = static_cast<load_status>(luaL_loadfile(L, filename.c_str()));
        return load_result(L, -1, 1, 1, x);
    }

    load_result load_buffer(const char *buff, size_t size, const char *name, const char* mode = nullptr) {
        load_status x = static_cast<load_status>(luaL_loadbufferx(L, buff, size, name, mode));
        return load_result(L, -1, 1, 1, x);
    }

    iterator begin () const {
        return global.begin();
    }

    iterator end() const {
        return global.end();
    }

    const_iterator cbegin() const {
        return global.cbegin();
    }

    const_iterator cend() const {
        return global.cend();
    }

    global_table globals() const {
        return global;
    }

    table registry() const {
        return reg;
    }

    operator lua_State* () const {
        return lua_state();
    }

    void set_panic(lua_CFunction panic){
        lua_atpanic(L, panic);
    }

    template<typename... Args, typename... Keys>
    decltype(auto) get(Keys&&... keys) const {
        return global.get<Args...>(std::forward<Keys>(keys)...);
    }

    template<typename T, typename Key>
    decltype(auto) get_or(Key&& key, T&& otherwise) const {
        return global.get_or(std::forward<Key>(key), std::forward<T>(otherwise));
    }

    template<typename T, typename Key, typename D>
    decltype(auto) get_or(Key&& key, D&& otherwise) const {
        return global.get_or<T>(std::forward<Key>(key), std::forward<D>(otherwise));
    }

    template<typename... Args>
    state_view& set(Args&&... args) {
        global.set(std::forward<Args>(args)...);
        return *this;
    }

    template<typename T, typename... Keys>
    decltype(auto) traverse_get(Keys&&... keys) const {
        return global.traverse_get<T>(std::forward<Keys>(keys)...);
    }

    template<typename... Args>
    state_view& traverse_set(Args&&... args) {
        global.traverse_set(std::forward<Args>(args)...);
        return *this;
    }

    template<typename T>
    state_view& set_usertype(usertype<T>& user) {
        return set_usertype(usertype_traits<T>::name, user);
    }

    template<typename Key, typename T>
    state_view& set_usertype(Key&& key, usertype<T>& user) {
        global.set_usertype(std::forward<Key>(key), user);
        return *this;
    }

    template<typename Class, typename... Args>
    state_view& new_usertype(const std::string& name, Args&&... args) {
        global.new_usertype<Class>(name, std::forward<Args>(args)...);
        return *this;
    }

    template<typename Class, typename CTor0, typename... CTor, typename... Args>
    state_view& new_usertype(const std::string& name, Args&&... args) {
        global.new_usertype<Class, CTor0, CTor...>(name, std::forward<Args>(args)...);
        return *this;
    }

    template<typename Class, typename... CArgs, typename... Args>
    state_view& new_usertype(const std::string& name, constructors<CArgs...> ctor, Args&&... args) {
        global.new_usertype<Class>(name, ctor, std::forward<Args>(args)...);
        return *this;
    }

    template <typename Fx>
    void for_each(Fx&& fx) {
        global.for_each(std::forward<Fx>(fx));
    }

    template<typename T>
    proxy<global_table&, T> operator[](T&& key) {
        return global[std::forward<T>(key)];
    }

    template<typename T>
    proxy<const global_table&, T> operator[](T&& key) const {
        return global[std::forward<T>(key)];
    }

    template<typename Sig, typename... Args, typename Key>
    state_view& set_function(Key&& key, Args&&... args) {
        global.set_function<Sig>(std::forward<Key>(key), std::forward<Args>(args)...);
        return *this;
    }

    template<typename... Args, typename Key>
    state_view& set_function(Key&& key, Args&&... args) {
        global.set_function(std::forward<Key>(key), std::forward<Args>(args)...);
        return *this;
    }

    template <typename Name>
    table create_table(Name&& name, int narr = 0, int nrec = 0) {
        return global.create(std::forward<Name>(name), narr, nrec);
    }

    template <typename Name, typename Key, typename Value, typename... Args>
    table create_table(Name&& name, int narr, int nrec, Key&& key, Value&& value, Args&&... args) {
        return global.create(std::forward<Name>(name), narr, nrec, std::forward<Key>(key), std::forward<Value>(value), std::forward<Args>(args)...);
    }

    template <typename Name, typename... Args>
    table create_named_table(Name&& name, Args&&... args) {
        table x = global.create_with(std::forward<Args>(args)...);
        global.set(std::forward<Name>(name), x);
        return x;
    }

    table create_table(int narr = 0, int nrec = 0) {
        return create_table(lua_state(), narr, nrec);
    }

    template <typename Key, typename Value, typename... Args>
    table create_table(int narr, int nrec, Key&& key, Value&& value, Args&&... args) {
        return create_table(lua_state(), narr, nrec, std::forward<Key>(key), std::forward<Value>(value), std::forward<Args>(args)...);
    }

    template <typename... Args>
    table create_table_with(Args&&... args) {
        return create_table_with(lua_state(), std::forward<Args>(args)...);
    }

    static inline table create_table(lua_State* L, int narr = 0, int nrec = 0) {
        return global_table::create(L, narr, nrec);
    }

    template <typename Key, typename Value, typename... Args>
    static inline table create_table(lua_State* L, int narr, int nrec, Key&& key, Value&& value, Args&&... args) {
        return global_table::create(L, narr, nrec, std::forward<Key>(key), std::forward<Value>(value), std::forward<Args>(args)...);
    }

    template <typename... Args>
    static inline table create_table_with(lua_State* L, Args&&... args) {
        return global_table::create_with(L, std::forward<Args>(args)...);
    }
};
} // sol

#endif // SOL_STATE_VIEW_HPP