// This file is distributed under the BSD License. // See "license.txt" for details. // Copyright 2009-2012, Jonathan Turner (jonathan@emptycrate.com) // Copyright 2009-2016, Jason Turner (jason@emptycrate.com) // http://www.chaiscript.com #ifndef CHAISCRIPT_ENGINE_HPP_ #define CHAISCRIPT_ENGINE_HPP_ #include #include #include #include #include #include #include #include #include #include #include #include "../chaiscript_defines.hpp" #include "../chaiscript_threading.hpp" #include "../dispatchkit/boxed_cast_helper.hpp" #include "../dispatchkit/boxed_value.hpp" #include "../dispatchkit/dispatchkit.hpp" #include "../dispatchkit/type_conversions.hpp" #include "../dispatchkit/proxy_functions.hpp" #include "chaiscript_common.hpp" #if defined(__linux__) || defined(__unix__) || defined(__APPLE__) || defined(__HAIKU__) #include #endif #if defined(_POSIX_VERSION) && !defined(__CYGWIN__) #include #endif #ifdef CHAISCRIPT_WINDOWS #include "chaiscript_windows.hpp" #elif _POSIX_VERSION #include "chaiscript_posix.hpp" #else #include "chaiscript_unknown.hpp" #endif #include "../dispatchkit/exception_specification.hpp" namespace chaiscript { namespace detail { typedef std::shared_ptr Loadable_Module_Ptr; } /// \brief The main object that the ChaiScript user will use. class ChaiScript_Basic { mutable chaiscript::detail::threading::shared_mutex m_mutex; mutable chaiscript::detail::threading::recursive_mutex m_use_mutex; std::set m_used_files; std::map m_loaded_modules; std::set m_active_loaded_modules; std::vector m_module_paths; std::vector m_use_paths; std::unique_ptr m_parser; chaiscript::detail::Dispatch_Engine m_engine; /// Evaluates the given string in by parsing it and running the results through the evaluator Boxed_Value do_eval(const std::string &t_input, const std::string &t_filename = "__EVAL__", bool /* t_internal*/ = false) { try { const auto p = m_parser->parse(t_input, t_filename); return p->eval(chaiscript::detail::Dispatch_State(m_engine)); } catch (chaiscript::eval::detail::Return_Value &rv) { return rv.retval; } } /// Evaluates the given file and looks in the 'use' paths const Boxed_Value internal_eval_file(const std::string &t_filename) { for (const auto &path : m_use_paths) { try { const auto appendedpath = path + t_filename; return do_eval(load_file(appendedpath), appendedpath, true); } catch (const exception::file_not_found_error &) { // failed to load, try the next path } catch (const exception::eval_error &t_ee) { throw Boxed_Value(t_ee); } } // failed to load by any name throw exception::file_not_found_error(t_filename); } /// Evaluates the given string, used during eval() inside of a script const Boxed_Value internal_eval(const std::string &t_e) { try { return do_eval(t_e, "__EVAL__", true); } catch (const exception::eval_error &t_ee) { throw Boxed_Value(t_ee); } } /// Returns the current evaluation m_engine chaiscript::detail::Dispatch_Engine &get_eval_engine() { return m_engine; } /// Builds all the requirements for ChaiScript, including its evaluator and a run of its prelude. void build_eval_system(const ModulePtr &t_lib, const std::vector &t_opts) { if (t_lib) { add(t_lib); } m_engine.add(fun([this](){ m_engine.dump_system(); }), "dump_system"); m_engine.add(fun([this](const Boxed_Value &t_bv){ m_engine.dump_object(t_bv); }), "dump_object"); m_engine.add(fun([this](const Boxed_Value &t_bv, const std::string &t_type){ return m_engine.is_type(t_bv, t_type); }), "is_type"); m_engine.add(fun([this](const Boxed_Value &t_bv){ return m_engine.type_name(t_bv); }), "type_name"); m_engine.add(fun([this](const std::string &t_f){ return m_engine.function_exists(t_f); }), "function_exists"); m_engine.add(fun([this](){ return m_engine.get_function_objects(); }), "get_functions"); m_engine.add(fun([this](){ return m_engine.get_scripting_objects(); }), "get_objects"); m_engine.add( dispatch::make_dynamic_proxy_function( [this](const std::vector &t_params) { return m_engine.call_exists(t_params); }) , "call_exists"); m_engine.add(fun( [=](const dispatch::Proxy_Function_Base &t_fun, const std::vector &t_params) -> Boxed_Value { Type_Conversions_State s(this->m_engine.conversions(), this->m_engine.conversions().conversion_saves()); return t_fun(t_params, s); }), "call"); m_engine.add(fun([this](const Type_Info &t_ti){ return m_engine.get_type_name(t_ti); }), "name"); m_engine.add(fun([this](const std::string &t_type_name, bool t_throw){ return m_engine.get_type(t_type_name, t_throw); }), "type"); m_engine.add(fun([this](const std::string &t_type_name){ return m_engine.get_type(t_type_name, true); }), "type"); m_engine.add(fun( [=](const Type_Info &t_from, const Type_Info &t_to, const std::function &t_func) { m_engine.add(chaiscript::type_conversion(t_from, t_to, t_func)); } ), "add_type_conversion"); if (std::find(t_opts.begin(), t_opts.end(), Options::No_Load_Modules) == t_opts.end() && std::find(t_opts.begin(), t_opts.end(), Options::Load_Modules) != t_opts.end()) { m_engine.add(fun([this](const std::string &t_module, const std::string &t_file){ return load_module(t_module, t_file); }), "load_module"); m_engine.add(fun([this](const std::string &t_module){ return load_module(t_module); }), "load_module"); } if (std::find(t_opts.begin(), t_opts.end(), Options::No_External_Scripts) == t_opts.end() && std::find(t_opts.begin(), t_opts.end(), Options::External_Scripts) != t_opts.end()) { m_engine.add(fun([this](const std::string &t_file){ return use(t_file); }), "use"); m_engine.add(fun([this](const std::string &t_file){ return internal_eval_file(t_file); }), "eval_file"); } m_engine.add(fun([this](const std::string &t_str){ return internal_eval(t_str); }), "eval"); m_engine.add(fun([this](const AST_NodePtr &t_ast){ return eval(t_ast); }), "eval"); m_engine.add(fun([this](const std::string &t_str, const bool t_dump){ return parse(t_str, t_dump); }), "parse"); m_engine.add(fun([this](const std::string &t_str){ return parse(t_str); }), "parse"); m_engine.add(fun([this](const Boxed_Value &t_bv, const std::string &t_name){ add_global_const(t_bv, t_name); }), "add_global_const"); m_engine.add(fun([this](const Boxed_Value &t_bv, const std::string &t_name){ add_global(t_bv, t_name); }), "add_global"); m_engine.add(fun([this](const Boxed_Value &t_bv, const std::string &t_name){ set_global(t_bv, t_name); }), "set_global"); } /// Helper function for loading a file static std::string load_file(const std::string &t_filename) { std::ifstream infile(t_filename.c_str(), std::ios::in | std::ios::ate | std::ios::binary ); if (!infile.is_open()) { throw chaiscript::exception::file_not_found_error(t_filename); } const auto size = infile.tellg(); infile.seekg(0, std::ios::beg); assert(size >= 0); if (size == std::streampos(0)) { return std::string(); } else { std::vector v(static_cast(size)); infile.read(&v[0], size); return std::string(v.begin(), v.end()); } } std::vector ensure_minimum_path_vec(std::vector paths) { if (paths.empty()) { return {""}; } else { return paths; } } public: /// \brief Constructor for ChaiScript /// \param[in] t_lib Standard library to apply to this ChaiScript instance /// \param[in] t_modulepaths Vector of paths to search when attempting to load a binary module /// \param[in] t_usepaths Vector of paths to search when attempting to "use" an included ChaiScript file ChaiScript_Basic(const ModulePtr &t_lib, std::unique_ptr &&parser, std::vector t_module_paths = {}, std::vector t_use_paths = {}, const std::vector &t_opts = chaiscript::default_options()) : m_module_paths(ensure_minimum_path_vec(std::move(t_module_paths))), m_use_paths(ensure_minimum_path_vec(std::move(t_use_paths))), m_parser(std::move(parser)), m_engine(*m_parser) { #if defined(_POSIX_VERSION) && !defined(__CYGWIN__) // If on Unix, add the path of the current executable to the module search path // as windows would do union cast_union { Boxed_Value (ChaiScript_Basic::*in_ptr)(const std::string&); void *out_ptr; }; Dl_info rInfo; memset( &rInfo, 0, sizeof(rInfo) ); cast_union u; u.in_ptr = &ChaiScript_Basic::use; if ( (dladdr(static_cast(u.out_ptr), &rInfo) != 0) && (rInfo.dli_fname != nullptr) ) { std::string dllpath(rInfo.dli_fname); const size_t lastslash = dllpath.rfind('/'); if (lastslash != std::string::npos) { dllpath.erase(lastslash); } // Let's see if this is a link that we should expand std::vector buf(2048); const auto pathlen = readlink(dllpath.c_str(), &buf.front(), buf.size()); if (pathlen > 0 && static_cast(pathlen) < buf.size()) { dllpath = std::string(&buf.front(), static_cast(pathlen)); } m_module_paths.insert(m_module_paths.begin(), dllpath+"/"); } #endif build_eval_system(t_lib, t_opts); } /// \brief Constructor for ChaiScript. /// /// This version of the ChaiScript constructor attempts to find the stdlib module to load /// at runtime generates an error if it cannot be found. /// /// \param[in] t_modulepaths Vector of paths to search when attempting to load a binary module /// \param[in] t_usepaths Vector of paths to search when attempting to "use" an included ChaiScript file explicit ChaiScript_Basic(std::unique_ptr &&parser, std::vector t_module_paths = {}, std::vector t_use_paths = {}, const std::vector &t_opts = chaiscript::default_options()) : ChaiScript_Basic({}, std::move(parser), t_module_paths, t_use_paths, t_opts) { try { // attempt to load the stdlib load_module("chaiscript_stdlib-" + Build_Info::version()); } catch (const exception::load_module_error &t_err) { std::cout << "An error occured while trying to load the chaiscript standard library.\n" << "\n" << "You must either provide a standard library, or compile it in.\n" << "For an example of compiling the standard library in,\n" << "see: https://gist.github.com/lefticus/9456197\n" << "Compiling the stdlib in is the recommended and MOST SUPPORTED method.\n" << "\n" << "\n" << t_err.what(); throw; } } parser::ChaiScript_Parser_Base &get_parser() { return *m_parser; } const Boxed_Value eval(const AST_NodePtr &t_ast) { try { return t_ast->eval(chaiscript::detail::Dispatch_State(m_engine)); } catch (const exception::eval_error &t_ee) { throw Boxed_Value(t_ee); } } AST_NodePtr parse(const std::string &t_input, const bool t_debug_print = false) { const auto ast = m_parser->parse(t_input, "PARSE"); if (t_debug_print) { m_parser->debug_print(ast); } return ast; } std::string get_type_name(const Type_Info &ti) const { return m_engine.get_type_name(ti); } template std::string get_type_name() const { return get_type_name(user_type()); } /// \brief Loads and parses a file. If the file is already, it is not reloaded /// The use paths specified at ChaiScript construction time are searched for the /// requested file. /// /// \param[in] t_filename Filename to load and evaluate Boxed_Value use(const std::string &t_filename) { for (const auto &path : m_use_paths) { try { const auto appendedpath = path + t_filename; chaiscript::detail::threading::unique_lock l(m_use_mutex); chaiscript::detail::threading::unique_lock l2(m_mutex); Boxed_Value retval; if (m_used_files.count(appendedpath) == 0) { l2.unlock(); retval = eval_file(appendedpath); l2.lock(); m_used_files.insert(appendedpath); } return retval; // return, we loaded it, or it was already loaded } catch (const exception::file_not_found_error &) { // failed to load, try the next path } } // failed to load by any name throw exception::file_not_found_error(t_filename); } /// \brief Adds a constant object that is available in all contexts and to all threads /// \param[in] t_bv Boxed_Value to add as a global /// \param[in] t_name Name of the value to add /// \throw chaiscript::exception::global_non_const If t_bv is not a constant object /// \sa Boxed_Value::is_const ChaiScript_Basic &add_global_const(const Boxed_Value &t_bv, const std::string &t_name) { Name_Validator::validate_object_name(t_name); m_engine.add_global_const(t_bv, t_name); return *this; } /// \brief Adds a mutable object that is available in all contexts and to all threads /// \param[in] t_bv Boxed_Value to add as a global /// \param[in] t_name Name of the value to add /// \warning The user is responsible for making sure the object is thread-safe if necessary /// ChaiScript is thread-safe but provides no threading locking mechanism to the script ChaiScript_Basic &add_global(const Boxed_Value &t_bv, const std::string &t_name) { Name_Validator::validate_object_name(t_name); m_engine.add_global(t_bv, t_name); return *this; } ChaiScript_Basic &set_global(const Boxed_Value &t_bv, const std::string &t_name) { Name_Validator::validate_object_name(t_name); m_engine.set_global(t_bv, t_name); return *this; } /// \brief Represents the current state of the ChaiScript system. State and be saved and restored /// \warning State object does not contain the user defined type conversions of the engine. They /// are left out due to performance considerations involved in tracking the state /// \sa ChaiScript::get_state /// \sa ChaiScript::set_state struct State { std::set used_files; chaiscript::detail::Dispatch_Engine::State engine_state; std::set active_loaded_modules; }; /// \brief Returns a state object that represents the current state of the global system /// /// The global system includes the reserved words, global const objects, functions and types. /// local variables are thread specific and not included. /// /// \return Current state of the global system /// /// \b Example: /// /// \code /// chaiscript::ChaiScript chai; /// chaiscript::ChaiScript::State s = chai.get_state(); // represents bootstrapped initial state /// \endcode State get_state() const { chaiscript::detail::threading::lock_guard l(m_use_mutex); chaiscript::detail::threading::shared_lock l2(m_mutex); State s; s.used_files = m_used_files; s.engine_state = m_engine.get_state(); s.active_loaded_modules = m_active_loaded_modules; return s; } /// \brief Sets the state of the system /// /// The global system includes the reserved words, global objects, functions and types. /// local variables are thread specific and not included. /// /// \param[in] t_state New state to set /// /// \b Example: /// \code /// chaiscript::ChaiScript chai; /// chaiscript::ChaiScript::State s = chai.get_state(); // get initial state /// chai.add(chaiscript::fun(&somefunction), "somefunction"); /// chai.set_state(s); // restore initial state, which does not have the recently added "somefunction" /// \endcode void set_state(const State &t_state) { chaiscript::detail::threading::lock_guard l(m_use_mutex); chaiscript::detail::threading::shared_lock l2(m_mutex); m_used_files = t_state.used_files; m_active_loaded_modules = t_state.active_loaded_modules; m_engine.set_state(t_state.engine_state); } /// \returns All values in the local thread state, added through the add() function std::map get_locals() const { return m_engine.get_locals(); } /// \brief Sets all of the locals for the current thread state. /// /// \param[in] t_locals The map set of variables to replace the current state with /// /// Any existing locals are removed and the given set of variables is added void set_locals(const std::map &t_locals) { m_engine.set_locals(t_locals); } /// \brief Adds a type, function or object to ChaiScript. Objects are added to the local thread state. /// \param[in] t_t Item to add /// \param[in] t_name Name of item to add /// \returns Reference to current ChaiScript object /// /// \b Examples: /// \code /// chaiscript::ChaiScript chai; /// chai.add(chaiscript::user_type(), "MyClass"); // Add explicit type info (not strictly necessary) /// chai.add(chaiscript::fun(&MyClass::function), "function"); // Add a class method /// MyClass obj; /// chai.add(chaiscript::var(&obj), "obj"); // Add a pointer to a locally defined object /// \endcode /// /// \sa \ref adding_items template ChaiScript_Basic &add(const T &t_t, const std::string &t_name) { Name_Validator::validate_object_name(t_name); m_engine.add(t_t, t_name); return *this; } /// \brief Add a new conversion for upcasting to a base class /// \sa chaiscript::base_class /// \param[in] d Base class / parent class /// /// \b Example: /// \code /// chaiscript::ChaiScript chai; /// chai.add(chaiscript::base_class()); /// \endcode ChaiScript_Basic &add(const Type_Conversion &d) { m_engine.add(d); return *this; } /// \brief Adds all elements of a module to ChaiScript runtime /// \param[in] t_p The module to add. /// \sa chaiscript::Module ChaiScript_Basic &add(const ModulePtr &t_p) { t_p->apply(*this, this->get_eval_engine()); return *this; } /// \brief Load a binary module from a dynamic library. Works on platforms that support /// dynamic libraries. /// \param[in] t_module_name Name of the module to load /// /// The module is searched for in the registered module path folders (chaiscript::ChaiScript::ChaiScript) /// and with standard prefixes and postfixes: ("lib"|"")\(".dll"|".so"|".bundle"|""). /// /// Once the file is located, the system looks for the symbol "create_chaiscript_module_\". /// If no file can be found matching the search criteria and containing the appropriate entry point /// (the symbol mentioned above), an exception is thrown. /// /// \throw chaiscript::exception::load_module_error In the event that no matching module can be found. std::string load_module(const std::string &t_module_name) { std::vector errors; std::string version_stripped_name = t_module_name; size_t version_pos = version_stripped_name.find("-" + Build_Info::version()); if (version_pos != std::string::npos) { version_stripped_name.erase(version_pos); } std::vector prefixes{"lib", "cyg", ""}; std::vector postfixes{".dll", ".so", ".bundle", ""}; for (auto & elem : m_module_paths) { for (auto & prefix : prefixes) { for (auto & postfix : postfixes) { try { const auto name = elem + prefix + t_module_name + postfix; // std::cerr << "trying location: " << name << '\n'; load_module(version_stripped_name, name); return name; } catch (const chaiscript::exception::load_module_error &e) { // std::cerr << "error: " << e.what() << '\n'; errors.push_back(e); // Try next set } } } } throw chaiscript::exception::load_module_error(t_module_name, errors); } /// \brief Load a binary module from a dynamic library. Works on platforms that support /// dynamic libraries. /// /// \param[in] t_module_name Module name to load /// \param[in] t_filename Ignore normal filename search process and use specific filename /// /// \sa ChaiScript::load_module(const std::string &t_module_name) void load_module(const std::string &t_module_name, const std::string &t_filename) { chaiscript::detail::threading::lock_guard l(m_use_mutex); if (m_loaded_modules.count(t_module_name) == 0) { detail::Loadable_Module_Ptr lm(new detail::Loadable_Module(t_module_name, t_filename)); m_loaded_modules[t_module_name] = lm; m_active_loaded_modules.insert(t_module_name); add(lm->m_moduleptr); } else if (m_active_loaded_modules.count(t_module_name) == 0) { m_active_loaded_modules.insert(t_module_name); add(m_loaded_modules[t_module_name]->m_moduleptr); } } /// \brief Evaluates a string. Equivalent to ChaiScript::eval. /// /// \param[in] t_script Script to execute /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions /// /// \return result of the script execution /// /// \throw chaiscript::exception::eval_error In the case that evaluation fails. Boxed_Value operator()(const std::string &t_script, const Exception_Handler &t_handler = Exception_Handler()) { return eval(t_script, t_handler); } /// \brief Evaluates a string and returns a typesafe result. /// /// \tparam T Type to extract from the result value of the script execution /// \param[in] t_input Script to execute /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions /// \param[in] t_filename Optional filename to report to the user for where the error occured. Useful /// in special cases where you are loading a file internally instead of using eval_file /// /// \return result of the script execution /// /// \throw chaiscript::exception::eval_error In the case that evaluation fails. /// \throw chaiscript::exception::bad_boxed_cast In the case that evaluation succeeds but the result value cannot be converted /// to the requested type. template T eval(const std::string &t_input, const Exception_Handler &t_handler = Exception_Handler(), const std::string &t_filename="__EVAL__") { return m_engine.boxed_cast(eval(t_input, t_handler, t_filename)); } /// \brief casts an object while applying any Dynamic_Conversion available template decltype(auto) boxed_cast(const Boxed_Value &bv) const { return(m_engine.boxed_cast(bv)); } /// \brief Evaluates a string. /// /// \param[in] t_input Script to execute /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions /// \param[in] t_filename Optional filename to report to the user for where the error occurred. Useful /// in special cases where you are loading a file internally instead of using eval_file /// /// \return result of the script execution /// /// \throw exception::eval_error In the case that evaluation fails. Boxed_Value eval(const std::string &t_input, const Exception_Handler &t_handler = Exception_Handler(), const std::string &t_filename="__EVAL__") { try { return do_eval(t_input, t_filename); } catch (Boxed_Value &bv) { if (t_handler) { t_handler->handle(bv, m_engine); } throw; } } /// \brief Loads the file specified by filename, evaluates it, and returns the result. /// \param[in] t_filename File to load and parse. /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions /// \return result of the script execution /// \throw chaiscript::exception::eval_error In the case that evaluation fails. Boxed_Value eval_file(const std::string &t_filename, const Exception_Handler &t_handler = Exception_Handler()) { return eval(load_file(t_filename), t_handler, t_filename); } /// \brief Loads the file specified by filename, evaluates it, and returns the type safe result. /// \tparam T Type to extract from the result value of the script execution /// \param[in] t_filename File to load and parse. /// \param[in] t_handler Optional Exception_Handler used for automatic unboxing of script thrown exceptions /// \return result of the script execution /// \throw chaiscript::exception::eval_error In the case that evaluation fails. /// \throw chaiscript::exception::bad_boxed_cast In the case that evaluation succeeds but the result value cannot be converted /// to the requested type. template T eval_file(const std::string &t_filename, const Exception_Handler &t_handler = Exception_Handler()) { return m_engine.boxed_cast(eval_file(t_filename, t_handler)); } }; } #endif /* CHAISCRIPT_ENGINE_HPP_ */