From 1bd73884b28e3241cd6aa4afe272d29c6cce9aec Mon Sep 17 00:00:00 2001 From: Jason Turner Date: Wed, 18 Nov 2009 05:05:40 +0000 Subject: [PATCH] Add documentation to the set_state get_state functions --- .../chaiscript/language/chaiscript_engine.hpp | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/include/chaiscript/language/chaiscript_engine.hpp b/include/chaiscript/language/chaiscript_engine.hpp index ec54247..82a1c2e 100644 --- a/include/chaiscript/language/chaiscript_engine.hpp +++ b/include/chaiscript/language/chaiscript_engine.hpp @@ -345,24 +345,32 @@ namespace chaiscript typename Eval_Engine::State engine_state; }; + /** + * Returns a state object that represents the current + * set of loaded files, the set of global variables and + * the set of initialized functions + */ State get_state() { - boost::lock_guard l(use_mutex); - boost::shared_lock l2(mutex); + boost::lock_guard l(use_mutex); + boost::shared_lock l2(mutex); - State s; - s.loaded_files = loaded_files; - s.engine_state = engine.get_state(); - return s; + State s; + s.loaded_files = loaded_files; + s.engine_state = engine.get_state(); + return s; } + /** + * Restores the state from a saved State object. + */ void set_state(const State &t_state) { - boost::lock_guard l(use_mutex); - boost::shared_lock l2(mutex); + boost::lock_guard l(use_mutex); + boost::shared_lock l2(mutex); - loaded_files = t_state.loaded_files; - engine.set_state(t_state.engine_state); + loaded_files = t_state.loaded_files; + engine.set_state(t_state.engine_state); } /**