Added script context to GScriptWrapper. Now the override-from-script C++ functions can do a lot more than before, such as transfering the ownership.

Author: wqking

include/cpgf/metatraits/gmetascriptwrapper.h

@@ -1,22 +1,19 @@
 #ifndef CPGF_GMETASCRIPTWRAPPER_H
 #define CPGF_GMETASCRIPTWRAPPER_H
 
-
 #include "cpgf/gapiutil.h"
 
-
 namespace cpgf {
 
-
 struct IScriptDataStorage;
+struct IScriptContext;
 struct GMetaTraitsParam;
 
 struct IMetaScriptWrapper : public IObject
 {
-	virtual void G_API_CC setScriptDataStorage(void * instance, IScriptDataStorage * scriptDataStorage) = 0;
+	virtual void G_API_CC initializeScriptWrapper(void * instance, IScriptDataStorage * scriptDataStorage, IScriptContext * scriptContext) = 0;
 };
 
-
 template <typename T>
 struct GMetaTraitsCreateScriptWrapper
 {
@@ -32,9 +29,7 @@ inline IMetaScriptWrapper * metaTraitsCreateScriptWrapper(const GMetaTraitsParam
 }
 
 
-
 } // namespace cpgf
 
 
-
 #endif

include/cpgf/scriptbind/gscriptwrapper.h

@@ -21,13 +21,18 @@ class GScriptWrapper
 {
 public:
 	GScriptWrapper();
+	~GScriptWrapper();
 
 	IScriptFunction * getScriptFunction(const char * name) const;
 
-	void setScriptDataStorage(IScriptDataStorage * scriptDataStorage);
+	void initializeScriptWrapper(IScriptDataStorage * scriptDataStorage, IScriptContext * scriptContext);
+
+	// The caller must call releaseReference on the result
+	IScriptContext * getScriptContext() const;
 
 private:
 	GSharedInterface<IScriptDataStorage> scriptDataStorage;
+	GSharedInterface<IScriptContext> scriptContext;
 };
 
 class GScriptWrapperReentryGuard

src/scriptbind/gbindgluedata.cpp

@@ -216,7 +216,7 @@ void GObjectGlueData::initialize()
 		if(! this->objectInstance->dataStorage) {
 			this->objectInstance->dataStorage.reset(new GScriptDataStorage(GObjectGlueDataPointer(this->shareFromThis())));
 		}
-		scriptWrapper->setScriptDataStorage(this->getInstanceAddress(), this->objectInstance->dataStorage.get());
+		scriptWrapper->initializeScriptWrapper(this->getInstanceAddress(), this->objectInstance->dataStorage.get(), this->getBindingContext()->borrowScriptContext());
 	}
 }
 

src/scriptbind/gscriptwrapper.cpp

@@ -1,5 +1,6 @@
 #include "cpgf/scriptbind/gscriptwrapper.h"
 #include "cpgf/scriptbind/gscriptbindapi.h"
+#include "cpgf/scriptbind/gscriptbind.h"
 #include "cpgf/gclassutil.h"
 #include "cpgf/gapiutil.h"
 
@@ -8,7 +9,13 @@ namespace cpgf {
 
 
 GScriptWrapper::GScriptWrapper()
-	: scriptDataStorage(nullptr)
+	:
+		scriptDataStorage(),
+		scriptContext()
+{
+}
+
+GScriptWrapper::~GScriptWrapper()
 {
 }
 
@@ -22,11 +29,18 @@ IScriptFunction * GScriptWrapper::getScriptFunction(const char * name) const
 	}
 }
 
-void GScriptWrapper::setScriptDataStorage(IScriptDataStorage * scriptDataStorage)
+void GScriptWrapper::initializeScriptWrapper(IScriptDataStorage * scriptDataStorage, IScriptContext * scriptContext)
 {
 	this->scriptDataStorage.reset(scriptDataStorage);
+	this->scriptContext.reset(scriptContext);
 }
 
+IScriptContext * GScriptWrapper::getScriptContext() const
+{
+	IScriptContext * context = this->scriptContext.get();
+	context->addReference();
+	return context;
+}
 
 namespace scriptbind_internal {
 
@@ -41,8 +55,8 @@ class GMetaScriptWrapper : public IMetaScriptWrapper
 	virtual ~GMetaScriptWrapper() {
 	}
 
-	virtual void G_API_CC setScriptDataStorage(void * instance, IScriptDataStorage * scriptDataStorage) {
-		static_cast<GScriptWrapper *>(this->caster(instance))->setScriptDataStorage(scriptDataStorage);
+	virtual void G_API_CC initializeScriptWrapper(void * instance, IScriptDataStorage * scriptDataStorage, IScriptContext * scriptContext) {
+		static_cast<GScriptWrapper *>(this->caster(instance))->initializeScriptWrapper(scriptDataStorage, scriptContext);
 	}
 
 private:

test/metagen/metadata/include/meta_test_simpleoverridefromscript.h

@@ -46,7 +46,8 @@ class SimpleOverrideWrapper : public SimpleOverride, public cpgf::GScriptWrapper
         if(func)
         {
             cpgf::GScriptValue ret = cpgf::invokeScriptFunctionOnObject(func.get(), this);
-            ret.discardOwnership();
+            cpgf::GScopedInterface<cpgf::IScriptContext> scriptContext(this->getScriptContext());
+            scriptContext->setAllowGC(&ret.getValue().refData(), false);
             return cpgf::fromVariant<SimpleOverrideHelperData * >(ret.getValue());
         }
         return SimpleOverride::createHelperData();

test/metagen/tests/test_metagen_simpleoverridefromscript.cpp

@@ -154,8 +154,10 @@ void doTestSimpleOverrideFromScript_discardOwnership(T * /* binding */, TestScri
 	QDO(DerivedClass.createHelperData = createHelperData)
 
 	QVARNEWOBJ(a, DerivedClass(0))
-// This causes test failure, just comment it out for now, will check later.
-//	QDO(a.consumeHelperData())
+
+	// This line tests the overrided createHelperData in SimpleOverrideWrapper
+	// the line will crash if the result value from doesn't discard ownership.
+	QDO(a.consumeHelperData())
 
 	// there is no explicit assertion as it has to be done at a layer above this test, e.g. valgrind
 	// checking the double-free

tools/metagen/tool/src/org/cpgf/metagen/metawriter/ClassWrapperWriter.java

@@ -97,7 +97,8 @@ private void doWriteOverrideVirtualMethod(CppWriter codeWriter, CppMethod cppMet
 		if(cppMethod.hasResult()) {
 			if (cppMethod.getDiscardResultOwnership()) {
 				codeWriter.writeLine("cpgf::GScriptValue ret = " + invoke + ";");
-				codeWriter.writeLine("ret.discardOwnership();");
+				codeWriter.writeLine("cpgf::GScopedInterface<cpgf::IScriptContext> scriptContext(this->getScriptContext());");
+				codeWriter.writeLine("scriptContext->setAllowGC(&ret.getValue().refData(), false);");
 				invoke = "return cpgf::fromVariant<" + cppMethod.getResultType().getLiteralType() + " >(ret.getValue())";
 			} else {
 				invoke = "return cpgf::fromVariant<" + cppMethod.getResultType().getLiteralType() + " >(" + invoke + ".getValue())";