OpenToonz - An open-source full-featured 2D animation creation software
C
Refactor script binding infrastructure with improved code organization
andeoncf54a4badfa2
diff --git a/toonz/sources/include/toonz/scriptbinding.h b/toonz/sources/include/toonz/scriptbinding.hindex 2168539b2..56e3ed621 100644--- a/toonz/sources/include/toonz/scriptbinding.h+++ b/toonz/sources/include/toonz/scriptbinding.h@@ -17,6 +17,7 @@#include "tgeometry.h"#include "tcommon.h"+#undef DVAPI#undef DVVAR#ifdef TOONZLIB_EXPORTS@@ -27,6 +28,7 @@#define DVVAR DV_IMPORT_VAR#endif+// Macro for standard wrapper methods#define WRAPPER_STD_METHODS(T) \static QScriptValue ctor(QScriptContext *context, QScriptEngine *engine); \static QScriptValue toScriptValue(QScriptEngine *engine, T *const &in) { \@@ -36,11 +38,13 @@out = qobject_cast<T *>(object.toQObject()); \}+// Macro for standard constructor implementation#define WRAPPER_STD_CTOR_IMPL(T) \QScriptValue T::ctor(QScriptContext *context, QScriptEngine *engine) { \return engine->newQObject(new T(), QScriptEngine::AutoOwnership); \}+// Forward declarationsclass TAffine;class TLevelReader;class ToonzScene;@@ -64,7 +68,7 @@ public:Wrapper();virtual ~Wrapper();- Q_PROPERTY(int id READ getId())+ Q_PROPERTY(int id READ getId)int getId() const { return m_id; }void print(const QString &msg);@@ -91,22 +95,24 @@ protected:}};+// Initialize all script bindingsvoid bindAll(QScriptEngine &engine);-// helper functions+// Helper functions-// check the number of arguments: if it is out of range returns an error object+// Check the number of arguments: if it is out of range returns an error objectQScriptValue checkArgumentCount(QScriptContext *context, const QString &name,int minCount, int maxCount);QScriptValue checkArgumentCount(QScriptContext *context, const QString &name,int count);-// check the color. if colorName is not valid then an error is returned+// Check the color. if colorName is not valid then an error is returnedQScriptValue checkColor(QScriptContext *context, const QString &colorName,QColor &color);} // namespace TScriptBinding+// Declare meta-type for script bindingQ_DECLARE_METATYPE(TScriptBinding::Void *)-#endif+#endif // SCRIPTBINDING_Hdiff --git a/toonz/sources/toonzlib/scriptbinding.cpp b/toonz/sources/toonzlib/scriptbinding.cppindex aa9850d27..e056f94be 100644--- a/toonz/sources/toonzlib/scriptbinding.cpp+++ b/toonz/sources/toonzlib/scriptbinding.cpp@@ -1,6 +1,8 @@#include "toonz/scriptbinding.h"++// TnzLib includes#include "toonz/scriptbinding_scene.h"#include "toonz/scriptbinding_image.h"#include "toonz/scriptbinding_level.h"@@ -11,25 +13,28 @@#include "toonz/scriptbinding_rasterizer.h"#include "toonz/scriptbinding_toonz_raster_converter.h"#include "toonz/scriptbinding_image_builder.h"-#include <QScriptEngine>-#include "tlevel_io.h"-#include "tlevel.h"#include "toonz/tcenterlinevectorizer.h"#include "toonz/tcamera.h"+#include "toonz/stage.h"+#include "toonz/txshleveltypes.h"+#include "toonz/levelproperties.h"+#include "toonz/toonzscene.h"++// TnzBase includes+#include "tlevel.h"#include "trop.h"#include "trasterimage.h"#include "ttoonzimage.h"#include "tvectorimage.h"#include "tpalette.h"-#include "tofflinegl.h"#include "tvectorrenderdata.h"#include "tgeometry.h"-#include "toonz/stage.h"-#include "toonz/txshleveltypes.h"-#include "toonz/levelproperties.h"-#include "toonz/toonzscene.h"#include "tfiletype.h"-#include <QRegExp>+#include "tofflinegl.h"+#include "tlevel_io.h"++// Qt includes+#include <QScriptEngine>#include <QColor>namespace TScriptBinding {@@ -42,9 +47,9 @@ WRAPPER_STD_CTOR_IMPL(Void)int Wrapper::m_count = 0;-Wrapper::Wrapper() { m_id = ++m_count; }+Wrapper::Wrapper() : m_id(++m_count) {}-Wrapper::~Wrapper() {}+Wrapper::~Wrapper() = default;void Wrapper::print(const QString &msg) {QScriptValueList lst;@@ -53,15 +58,19 @@ void Wrapper::print(const QString &msg) {}void Wrapper::print(const QScriptValueList &lst) {- QScriptValue print = engine()->globalObject().property("print");- print.call(print, lst);+ QScriptValue printFunc = engine()->globalObject().property("print");+ if (printFunc.isFunction()) {+ printFunc.call(QScriptValue(), lst);+ }}void Wrapper::warning(const QString &msg) {QScriptValueList lst;lst << msg;- QScriptValue f = engine()->globalObject().property("warning");- f.call(f, lst);+ QScriptValue warningFunc = engine()->globalObject().property("warning");+ if (warningFunc.isFunction()) {+ warningFunc.call(QScriptValue(), lst);+ }}//===========================================================================@@ -70,15 +79,17 @@ QScriptValue checkArgumentCount(QScriptContext *context, const QString &name,int minCount, int maxCount) {int count = context->argumentCount();if (minCount <= count && count <= maxCount) return QScriptValue();+QString range;- if (minCount != maxCount)+ if (minCount != maxCount) {range = QObject::tr("%1-%2").arg(minCount).arg(maxCount);- else+ } else {range = QObject::tr("%1").arg(minCount);+ }+return context->throwError(QObject::tr("Expected %1 argument(s) in %2, got %3")- .arg(range)- .arg(name)+ .arg(range, name).arg(count));}@@ -90,13 +101,13 @@ QScriptValue checkArgumentCount(QScriptContext *context, const QString &name,QScriptValue checkColor(QScriptContext *context, const QString &colorName,QColor &color) {color.setNamedColor(colorName);- if (!color.isValid())+ if (!color.isValid()) {return context->throwError(QObject::tr("%1 is not a valid color (valid color names are 'red', "- "'transparent', '#FF8800', ecc.)")+ "'transparent', '#FF8800', etc.)").arg(colorName));- else- return QScriptValue();+ }+ return QScriptValue();}//=============================================================================@@ -128,23 +139,30 @@ int qScriptRegisterQObjectMetaType(}template <class T, QScriptValue (T::*Method)(QScriptContext *, QScriptEngine *)>-class Dummy {+class StaticMethodWrapper {public:- static QScriptValue dummy(QScriptContext *context, QScriptEngine *engine) {+ static QScriptValue wrap(QScriptContext *context, QScriptEngine *engine) {T *obj = qscriptvalue_cast<T *>(context->thisObject());+ if (!obj) {+ return engine->undefinedValue();+ }return (obj->*Method)(context, engine);}};-static void deffoo(QScriptEngine &engine) {- QScriptValue f = engine.newFunction(- Dummy<ToonzRasterConverter, &ToonzRasterConverter::convert>::dummy);+static void setupStaticMethods(QScriptEngine &engine) {+ // Setup static methods for classes if needed+ // Example: ToonzRasterConverter::convert+ QScriptValue convertFunc = engine.newFunction(+ StaticMethodWrapper<ToonzRasterConverter,+ &ToonzRasterConverter::convert>::wrap);engine.globalObject().property("ToonzRasterConverter")- .setProperty("convert", f);+ .setProperty("convert", convertFunc);}void bindAll(QScriptEngine &engine) {+ // Bind all scriptable classesbindClass<Image>(engine, "Image");bindClass<Level>(engine, "Level");bindClass<Scene>(engine, "Scene");@@ -154,14 +172,20 @@ void bindAll(QScriptEngine &engine) {bindClass<CenterlineVectorizer>(engine, "CenterlineVectorizer");bindClass<Rasterizer>(engine, "Rasterizer");bindClass<ToonzRasterConverter>(engine, "ToonzRasterConverter");- deffoo(engine);bindClass<FilePath>(engine, "FilePath");bindClass<Renderer>(engine, "Renderer");+ // Setup any static methods+ setupStaticMethods(engine);++ // Register meta types for script bindingqScriptRegisterQObjectMetaType<TScriptBinding::Image *>(&engine);+ // Set version information in the script environmentengine.evaluate("ToonzVersion='7.1'");- // engine.evaluate("toonz={version:'7.0', }; script={version:'1.0'};");++ // Additional global script setup could go here+ // Example: engine.evaluate("toonz={version:'7.0'}; script={version:'1.0'};");// engine.globalObject().setProperty("dir","C:\\Users\\gmt\\GMT to// vectorize\\");// QScriptValue test = engine.evaluate("function() { print('ok');