mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-10 04:57:00 -04:00
GenevensiS
226 lines
9.0 KiB
C++
226 lines
9.0 KiB
C++
//+----------------------------------------------------------------------------+
|
|
//| Description: Magic Set Editor - Program to make card games |
|
|
//| Copyright: (C) Twan van Laarhoven and the other MSE developers |
|
|
//| License: GNU General Public License 2 or later (see file COPYING) |
|
|
//+----------------------------------------------------------------------------+
|
|
|
|
#pragma once
|
|
|
|
/** @file script/functions/util.cpp
|
|
*
|
|
* @brief Utility macros for defining script functions.
|
|
*/
|
|
|
|
// ----------------------------------------------------------------------------- : Includes
|
|
|
|
#include <util/prec.hpp>
|
|
#include <util/error.hpp>
|
|
#include <script/to_value.hpp>
|
|
#include <script/context.hpp>
|
|
|
|
// ----------------------------------------------------------------------------- : Functions
|
|
|
|
/// Macro to declare a new script function
|
|
/** Usage:
|
|
* @code
|
|
* SCRIPT_FUNCTION(my_function) {
|
|
* // function code goes here
|
|
* }
|
|
* @endcode
|
|
* This declares a value 'script_my_function' which can be added as a variable to a context
|
|
* using:
|
|
* @code
|
|
* extern ScriptValueP script_my_function;
|
|
* context.setVariable("my_function", script_my_function);
|
|
* @endcode
|
|
*/
|
|
#define SCRIPT_FUNCTION(name) SCRIPT_FUNCTION_AUX(name,;)
|
|
|
|
/// Macro to declare a new script function with custom dependency handling
|
|
#define SCRIPT_FUNCTION_WITH_DEP(name) \
|
|
SCRIPT_FUNCTION_AUX(name, ScriptValueP dependencies(Context&, const Dependency&) const override;)
|
|
|
|
#define SCRIPT_FUNCTION_DEPENDENCIES(name) \
|
|
ScriptValueP ScriptBuiltIn_##name::dependencies(Context& ctx, const Dependency& dep) const
|
|
|
|
/// Macro to declare a new script function with custom closure simplification
|
|
#define SCRIPT_FUNCTION_WITH_SIMPLIFY(name) \
|
|
SCRIPT_FUNCTION_AUX(name, ScriptValueP simplifyClosure(ScriptClosure&) const override;)
|
|
|
|
#define SCRIPT_FUNCTION_SIMPLIFY_CLOSURE(name) \
|
|
ScriptValueP ScriptBuiltIn_##name::simplifyClosure(ScriptClosure& closure) const
|
|
|
|
// helper for SCRIPT_FUNCTION and SCRIPT_FUNCTION_DEP
|
|
#define SCRIPT_FUNCTION_AUX(name,dep) \
|
|
class ScriptBuiltIn_##name : public ScriptValue { \
|
|
dep \
|
|
ScriptType type() const override \
|
|
{ return SCRIPT_FUNCTION; } \
|
|
String typeName() const override \
|
|
{ return _("built-in function '") _(#name) _("'"); } \
|
|
ScriptValueP eval(Context&, bool) const override; \
|
|
}; \
|
|
ScriptValueP script_##name(new ScriptBuiltIn_##name); \
|
|
ScriptValueP ScriptBuiltIn_##name::eval(Context& ctx, bool) const
|
|
|
|
/// Return a value from a SCRIPT_FUNCTION
|
|
#define SCRIPT_RETURN(value) return to_script(value)
|
|
|
|
// ----------------------------------------------------------------------------- : Parameters
|
|
|
|
template <typename Type>
|
|
inline Type from_script(const ScriptValueP& v, const String& str) {
|
|
try {
|
|
return from_script<Type>(v);
|
|
} catch (ScriptError& e) {
|
|
throw ScriptError(_ERROR_2_("in parameter", str, e.what()));
|
|
}
|
|
}
|
|
template <typename Type>
|
|
inline Type from_script(const ScriptValueP& v, Variable var) {
|
|
try {
|
|
return from_script<Type>(v);
|
|
} catch (ScriptError& e) {
|
|
throw ScriptError(_ERROR_2_("in parameter", variable_to_string(var), e.what()));
|
|
}
|
|
}
|
|
|
|
/// Retrieve a parameter to a SCRIPT_FUNCTION with the given name and type
|
|
/** Usage:
|
|
* @code
|
|
* SCRIPT_FUNCTION(my_function) {
|
|
* SCRIPT_PARAM(String, my_string_param);
|
|
* ... my_string_param ...
|
|
* }
|
|
* @endcode
|
|
* Throws an error if the parameter is not found.
|
|
*/
|
|
#define SCRIPT_PARAM(Type, name) \
|
|
SCRIPT_PARAM_N(Type, _(#name), name)
|
|
#define SCRIPT_PARAM_N(Type, str, name) \
|
|
Type name = from_script<Type>(ctx.getVariable(str), str)
|
|
/// Faster variant of SCRIPT_PARAM when name is a CommonScriptVariable
|
|
/** Doesn't require a runtime lookup of the name */
|
|
#define SCRIPT_PARAM_C(Type, name) \
|
|
SCRIPT_PARAM_N(Type, SCRIPT_VAR_ ## name, name)
|
|
|
|
/// Retrieve an optional parameter
|
|
/** Usage:
|
|
* @code
|
|
* SCRIPT_FUNCTION(my_function) {
|
|
* SCRIPT_OPTIONAL_PARAM(String, my_string_param) {
|
|
* ... my_string_param ...
|
|
* }
|
|
* ...
|
|
* }
|
|
* @endcode
|
|
*/
|
|
#define SCRIPT_OPTIONAL_PARAM(Type, name) \
|
|
SCRIPT_OPTIONAL_PARAM_N(Type, _(#name), name)
|
|
/// Retrieve a named optional parameter
|
|
#define SCRIPT_OPTIONAL_PARAM_N(Type, str, name) \
|
|
SCRIPT_OPTIONAL_PARAM_N_(Type, str, name) \
|
|
if (name##_)
|
|
#define SCRIPT_OPTIONAL_PARAM_C(Type, name) \
|
|
SCRIPT_OPTIONAL_PARAM_N(Type, SCRIPT_VAR_ ## name, name)
|
|
|
|
/// Retrieve an optional parameter, can't be used as an if statement
|
|
#define SCRIPT_OPTIONAL_PARAM_(Type, name) \
|
|
SCRIPT_OPTIONAL_PARAM_N_(Type, _(#name), name)
|
|
/// Retrieve a named optional parameter, can't be used as an if statement
|
|
#define SCRIPT_OPTIONAL_PARAM_N_(Type, str, name) \
|
|
ScriptValueP name##_ = ctx.getVariableOpt(str); \
|
|
Type name = name##_ && name##_ != script_nil \
|
|
? from_script<Type>(name##_, str) : Type();
|
|
#define SCRIPT_OPTIONAL_PARAM_C_(Type, name) \
|
|
SCRIPT_OPTIONAL_PARAM_N_(Type, SCRIPT_VAR_ ## name, name)
|
|
|
|
/// Retrieve an optional parameter with a default value
|
|
#define SCRIPT_PARAM_DEFAULT(Type, name, def) \
|
|
SCRIPT_PARAM_DEFAULT_N(Type, _(#name), name, def)
|
|
/// Retrieve a named optional parameter with a default value
|
|
#define SCRIPT_PARAM_DEFAULT_N(Type, str, name, def) \
|
|
ScriptValueP name##_ = ctx.getVariableOpt(str); \
|
|
Type name = name##_ ? from_script<Type>(name##_, str) : def
|
|
#define SCRIPT_PARAM_DEFAULT_C(Type, name, def) \
|
|
SCRIPT_PARAM_DEFAULT_N(Type, SCRIPT_VAR_ ## name, name, def)
|
|
|
|
// ----------------------------------------------------------------------------- : Rules
|
|
|
|
/// Utility for defining a script rule with a single parameter
|
|
#define SCRIPT_RULE_1(funname, type1, name1) \
|
|
SCRIPT_RULE_1_N(funname, type1, _(#name1), name1)
|
|
#define SCRIPT_RULE_1_C(funname, type1, name1) \
|
|
SCRIPT_RULE_1_N(funname, type1, SCRIPT_VAR_ ## name1, name1)
|
|
/// Utility for defining a script rule with a single named parameter
|
|
#define SCRIPT_RULE_1_N(funname, type1, str1, name1) \
|
|
class ScriptRule_##funname: public ScriptValue { \
|
|
public: \
|
|
inline ScriptRule_##funname(const type1& name1) : name1(name1) {} \
|
|
ScriptType type() const override { return SCRIPT_FUNCTION; } \
|
|
String typeName() const override { return _(#funname)_("_rule"); } \
|
|
protected: \
|
|
ScriptValueP eval(Context& ctx, bool) const override; \
|
|
private: \
|
|
type1 name1; \
|
|
}; \
|
|
SCRIPT_FUNCTION(funname##_rule) { \
|
|
SCRIPT_PARAM_N(type1, str1, name1) \
|
|
return make_intrusive<ScriptRule_##funname>(name1); \
|
|
} \
|
|
SCRIPT_FUNCTION(funname) { \
|
|
SCRIPT_PARAM_N(type1, str1, name1); \
|
|
return ScriptRule_##funname(name1).eval(ctx); \
|
|
} \
|
|
ScriptValueP ScriptRule_##funname::eval(Context& ctx, bool) const
|
|
|
|
/// Utility for defining a script rule with two parameters
|
|
#define SCRIPT_RULE_2(funname, type1, name1, type2, name2) \
|
|
SCRIPT_RULE_2_N(funname, type1, _(#name1), name1, type2, _(#name2), name2)
|
|
#define SCRIPT_RULE_2_C(funname, type1, name1, type2, name2) \
|
|
SCRIPT_RULE_2_N(funname, type1, SCRIPT_VAR_ ## name1, name1, type2, SCRIPT_VAR_ ## name2, name2)
|
|
/// Utility for defining a script rule with two named parameters
|
|
#define SCRIPT_RULE_2_N(funname, type1, str1, name1, type2, str2, name2) \
|
|
SCRIPT_RULE_2_N_AUX(funname, type1, str1, name1, type2, str2, name2, ;, ;)
|
|
/// Utility for defining a script rule with two named parameters, with dependencies
|
|
#define SCRIPT_RULE_2_N_DEP(funname, type1, str1, name1, type2, str2, name2) \
|
|
SCRIPT_RULE_2_N_AUX( funname, type1, str1, name1, type2, str2, name2, \
|
|
ScriptValueP dependencies(Context&, const Dependency&) const override; \
|
|
SCRIPT_FUNCTION_DEPENDENCIES(funname) { \
|
|
SCRIPT_PARAM_N(type1, str1, name1); \
|
|
SCRIPT_PARAM_N(type2, str2, name2); \
|
|
return ScriptRule_##funname(name1, name2).dependencies(ctx, dep); \
|
|
})
|
|
|
|
#define SCRIPT_RULE_2_N_AUX(funname, type1, str1, name1, type2, str2, name2, dep, more) \
|
|
class ScriptRule_##funname: public ScriptValue { \
|
|
public: \
|
|
inline ScriptRule_##funname(const type1& name1, const type2& name2) \
|
|
: name1(name1), name2(name2) {} \
|
|
ScriptType type() const override { return SCRIPT_FUNCTION; } \
|
|
String typeName() const override { return _(#funname)_("_rule"); } \
|
|
dep \
|
|
protected: \
|
|
ScriptValueP eval(Context& ctx, bool) const override; \
|
|
private: \
|
|
type1 name1; \
|
|
type2 name2; \
|
|
}; \
|
|
SCRIPT_FUNCTION(funname##_rule) { \
|
|
SCRIPT_PARAM_N(type1, str1, name1); \
|
|
SCRIPT_PARAM_N(type2, str2, name2); \
|
|
return make_intrusive<ScriptRule_##funname>(name1, name2); \
|
|
} \
|
|
SCRIPT_FUNCTION_AUX(funname, dep) { \
|
|
SCRIPT_PARAM_N(type1, str1, name1); \
|
|
SCRIPT_PARAM_N(type2, str2, name2); \
|
|
return ScriptRule_##funname(name1, name2).eval(ctx); \
|
|
} \
|
|
more \
|
|
ScriptValueP ScriptRule_##funname::eval(Context& ctx, bool) const
|
|
|
|
#define SCRIPT_RULE_2_DEPENDENCIES(name) \
|
|
ScriptValueP ScriptRule_##name::dependencies(Context& ctx, const Dependency& dep) const
|
|
|
|
|