generic-library/ChaiScript
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add documentation to the set_state get_state functions

Browse Source
This commit is contained in:
Jason Turner
2009-11-18 05:05:40 +00:00
parent d3e4af433e
commit 1bd73884b2
1 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
include/chaiscript/language/chaiscript_engine.hpp
View File

@@ -345,24 +345,32 @@ namespace chaiscript
typename Eval_Engine::State engine_state; 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() State get_state()
{ {
boost::lock_guard<boost::recursive_mutex> l(use_mutex); boost::lock_guard<boost::recursive_mutex> l(use_mutex);
boost::shared_lock<boost::shared_mutex> l2(mutex); boost::shared_lock<boost::shared_mutex> l2(mutex);
State s; State s;
s.loaded_files = loaded_files; s.loaded_files = loaded_files;
s.engine_state = engine.get_state(); s.engine_state = engine.get_state();
return s; return s;
} }
/**
* Restores the state from a saved State object.
*/
void set_state(const State &t_state) void set_state(const State &t_state)
{ {
boost::lock_guard<boost::recursive_mutex> l(use_mutex); boost::lock_guard<boost::recursive_mutex> l(use_mutex);
boost::shared_lock<boost::shared_mutex> l2(mutex); boost::shared_lock<boost::shared_mutex> l2(mutex);
loaded_files = t_state.loaded_files; loaded_files = t_state.loaded_files;
engine.set_state(t_state.engine_state); engine.set_state(t_state.engine_state);
} }
/** /**