Add the ability to save and restore the state of local variables #25

This commit is contained in:
Jason Turner
2012-07-16 21:27:42 -06:00
parent f5b7be3743
commit 1155720b14
5 changed files with 117 additions and 4 deletions

View File

@@ -140,7 +140,10 @@
///
/// \subsubsection addingobjects Adding Objects
///
/// Named objects can be created with the chaiscript::var function.
/// Named objects can be created with the chaiscript::var function. Note: adding a object
/// adds it to the current thread scope, not to a global scope. If you have multiple
/// threads that need to access the same variables you will need to add them
/// separately for each thread, from the thread itself.
///
/// \code
/// using namespace chaiscript;

View File

@@ -666,6 +666,27 @@ namespace chaiscript
return functions.find(name) != functions.end();
}
/// \returns All values in the local thread state, added through the add() function
std::map<std::string, Boxed_Value> get_locals() const
{
StackData &stack = get_stack_data();
Scope &scope = stack.front();
return scope;
}
/// \brief Sets all of the locals for the current thread state.
///
/// \param[in] t_locals The map<name, value> 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<std::string, Boxed_Value> &t_locals)
{
StackData &stack = get_stack_data();
Scope &scope = stack.front();
scope = t_locals;
}
///
/// Get a map of all objects that can be seen from the current scope in a scripting context

View File

@@ -456,8 +456,12 @@ namespace chaiscript
std::set<std::string> active_loaded_modules;
};
/// \brief Returns a state object that represents the current state of the system
/// \return Current state of the system
/// \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:
///
@@ -478,6 +482,10 @@ namespace chaiscript
}
/// \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:
@@ -497,7 +505,23 @@ namespace chaiscript
m_engine.set_state(t_state.engine_state);
}
/// \brief Adds a type, function or object to ChaiScript
/// \returns All values in the local thread state, added through the add() function
std::map<std::string, Boxed_Value> 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<name, value> 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<std::string, Boxed_Value> &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