Fix memory leaks

1. DriverBase no destroyInstance
2. Every object inherited from ax::Ref shoud destory before ScriptEngineManager, otherwise will trigger it's reinit and leak
3.  QuadCommand always leak isolated indices
4. static singleton should'nt inhert from ax::Ref due to destory it before ScriptEngineManager impossible
5. Make Director inherit from ax::Ref due to it also cause ScriptEngineManager re-init, because we destroy ScriptEngineManger in destructor of Director
6. Explicit Director managed by Application and don't delete self at purgeDirector, since it will release at mainLoop and re-init in glView->pollEvents then leak
7. Rename ApplicationProtocol to ApplicationBase
8. TODO:
     a. rename purgeDirector since we don't delete director self at it, maye rename to cleanup
     b. change ShaderCache to new/delete singleton, Managed by DriverBase?
     c. other singleton checks (i.e dependency check)

CHANGELOG.md

@@ -5,6 +5,8 @@
 - Fix shaders not copying to final build on macOS for non Xcode builds by @smilediver
 - Fix `Scheduler::pauseTarget` can't timer targets, reported by @shaniamjad6
 - Fix build lua projects with engine prebuilts lib doesn't work, reported by @grif-on
+- Fix GUI ScrollView clipping bug and add lua support by @bintester
+- Ensure scissor state is set to the correct value prior to a buffer clear by @rh101
 
 ## Improvements
 

cmake/Modules/AXBuildHelpers.cmake

@@ -437,8 +437,6 @@ function(ax_setup_app_config app_name)
         # compile app shader to ${CMAKE_BINARY_DIR}/runtime/axslc/custom/
         ax_target_compile_shaders(${app_name} FILES ${app_shaders} CUSTOM)
         source_group("Source Files/Source/shaders" FILES ${app_shaders}) 
-    else()
-        message(STATUS "No shader found in ${app_shaders_dir}")
     endif()
 
     if (IS_DIRECTORY ${GLSLCC_OUT_DIR})

core/2d/ActionCoroutine.cpp

@@ -82,7 +82,7 @@ bool Coroutine::moveNext() const
 //
 ActionCoroutine* ActionCoroutine::create(const std::function<Coroutine()>& function)
 {
-    auto ret = new (std::nothrow) ActionCoroutine();
+    auto ret = new ActionCoroutine();
     if (ret && ret->initWithCoroutine(function))
     {
         ret->autorelease();

core/base/Director.cpp

@@ -90,14 +90,19 @@ Director* Director::getInstance()
 {
     if (!s_SharedDirector)
     {
-        s_SharedDirector = new Director;
+        s_SharedDirector = new Director();
         AXASSERT(s_SharedDirector, "FATAL: Not enough memory");
         s_SharedDirector->init();
     }
 
     return s_SharedDirector;
 }
 
+void Director::destroyInstance()
+{
+    AX_SAFE_DELETE(s_SharedDirector);
+}
+
 Director::Director() {}
 
 bool Director::init()
@@ -193,9 +198,15 @@ Director::~Director()
 
     s_SharedDirector = nullptr;
 
+    backend::DriverBase::destroyInstance();
+    QuadCommand::destroyIsolatedIndices();
+
 #if AX_ENABLE_SCRIPT_BINDING
     ScriptEngineManager::destroyInstance();
 #endif
+
+    /** clean auto release pool. */
+    PoolManager::destroyInstance();
 }
 
 void Director::setDefaultValues()
@@ -1044,6 +1055,7 @@ void Director::reset()
     SpriteFrameCache::destroyInstance();
     FileUtils::destroyInstance();
     AsyncTaskPool::destroyInstance();
+    backend::ProgramStateRegistry::destroyInstance();
     backend::ProgramManager::destroyInstance();
 
     // axmol specific data structures
@@ -1066,9 +1078,6 @@ void Director::purgeDirector()
         _glView = nullptr;
     }
 
-    // delete Director
-    release();
-
 #if AX_TARGET_PLATFORM == AX_PLATFORM_IOS || AX_TARGET_PLATFORM == AX_PLATFORM_ANDROID
     utils::killCurrentProcess();
 #endif

core/base/Director.h

@@ -77,7 +77,7 @@ class Console;
  Since the Director is a singleton, the standard way to use it is by calling:
  _ Director::getInstance()->methodName();
  */
-class AX_DLL Director : public Ref
+class AX_DLL Director
 {
 public:
     /** Director will trigger an event before set next scene. */
@@ -123,6 +123,7 @@ class AX_DLL Director : public Ref
      * @js _getInstance
      */
     static Director* getInstance();
+    static void destroyInstance();
 
     /**
      * @js ctor

core/platform/ApplicationBase.cpp

@@ -0,0 +1,11 @@
+#include "ApplicationBase.h"
+#include "base/Director.h"
+
+NS_AX_BEGIN
+
+ApplicationBase::~ApplicationBase()
+{
+    Director::destroyInstance();
+}
+
+NS_AX_END

core/platform/ApplicationProtocol.h → core/platform/ApplicationBase.h

@@ -24,8 +24,8 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 ****************************************************************************/
 
-#ifndef __AX_APPLICATION_PROTOCOL_H__
-#define __AX_APPLICATION_PROTOCOL_H__
+#ifndef __AX_APPLICATION_BASE_H__
+#define __AX_APPLICATION_BASE_H__
 
 #include "platform/PlatformMacros.h"
 #include "base/AutoreleasePool.h"
@@ -38,7 +38,7 @@ NS_AX_BEGIN
  * @{
  */
 
-class AX_DLL ApplicationProtocol
+class AX_DLL ApplicationBase
 {
 public:
     /** Since WINDOWS and ANDROID are defined as macros, we could not just use these keywords in enumeration(Platform).
@@ -65,11 +65,7 @@ class AX_DLL ApplicationProtocol
      * @js NA
      * @lua NA
      */
-    virtual ~ApplicationProtocol()
-    {
-        /** clean auto release pool. */
-        PoolManager::destroyInstance();
-    }
+    virtual ~ApplicationBase();
 
     /**
      * @brief    Implement Director and Scene init code here.
@@ -152,6 +148,8 @@ class AX_DLL ApplicationProtocol
     virtual bool openURL(std::string_view url) = 0;
 };
 
+using ApplicationProtocol = ApplicationBase;
+
 // end of platform group
 /** @} */
 

core/platform/CMakeLists.txt

@@ -171,7 +171,7 @@ endif()
 set(_AX_PLATFORM_HEADER
     ${_AX_PLATFORM_SPECIFIC_HEADER}
     platform/Application.h
-    platform/ApplicationProtocol.h
+    platform/ApplicationBase.h
     platform/Common.h
     platform/Device.h
     platform/FileUtils.h
@@ -194,4 +194,5 @@ set(_AX_PLATFORM_SRC
     platform/FileUtils.cpp
     platform/Image.cpp
     platform/FileStream.cpp
+    platform/ApplicationBase.cpp
     )

core/platform/android/Application-android.h

@@ -26,11 +26,11 @@ THE SOFTWARE.
 #pragma once
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 
 NS_AX_BEGIN
 
-class AX_DLL Application : public ApplicationProtocol
+class AX_DLL Application : public ApplicationBase
 {
 public:
     /**

core/platform/android/EnhanceAPI-android.h

@@ -15,7 +15,7 @@
 #pragma once
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 
 NS_AX_BEGIN
 

core/platform/ios/Application-ios.h

@@ -26,11 +26,11 @@ THE SOFTWARE.
 #pragma once
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 
 NS_AX_BEGIN
 
-class AX_DLL Application : public ApplicationProtocol
+class AX_DLL Application : public ApplicationBase
 {
 public:
     /**

core/platform/linux/Application-linux.h

@@ -26,14 +26,14 @@ THE SOFTWARE.
 #pragma once
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 #include <string>
 #include <chrono>
 
 NS_AX_BEGIN
 class Rect;
 
-class Application : public ApplicationProtocol
+class Application : public ApplicationBase
 {
 public:
     /**

core/platform/mac/Application-mac.h

@@ -26,13 +26,13 @@ THE SOFTWARE.
 #pragma once
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 #include <string>
 #include <chrono>
 
 NS_AX_BEGIN
 
-class AX_DLL Application : public ApplicationProtocol
+class AX_DLL Application : public ApplicationBase
 {
 public:
     /**

core/platform/wasm/Application-wasm.h

@@ -31,13 +31,13 @@ THE SOFTWARE.
 #if AX_TARGET_PLATFORM == AX_PLATFORM_WASM
 
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 #include <string>
 
 NS_AX_BEGIN
 class Rect;
 
-class Application : public ApplicationProtocol
+class Application : public ApplicationBase
 {
 public:
     /**

core/platform/win32/Application-win32.cpp

@@ -128,6 +128,7 @@ int Application::run()
     }
     glView->release();
 
+
     return 0;
 }
 

core/platform/win32/Application-win32.h

@@ -27,12 +27,12 @@ THE SOFTWARE.
 
 #include "platform/StdC.h"
 #include "platform/Common.h"
-#include "platform/ApplicationProtocol.h"
+#include "platform/ApplicationBase.h"
 #include <string>
 
 NS_AX_BEGIN
 
-class AX_DLL Application : public ApplicationProtocol
+class AX_DLL Application : public ApplicationBase
 {
 public:
     /**

core/platform/winrt/Application-winrt.h

@@ -31,14 +31,14 @@ THE SOFTWARE.
 
 #    include "platform/StdC.h"
 #    include "platform/Common.h"
-#    include "platform/ApplicationProtocol.h"
+#    include "platform/ApplicationBase.h"
 #    include "platform/winrt/InputEvent.h"
 #    include <string>
 #    include <functional>
 
 NS_AX_BEGIN
 
-class AX_DLL Application : public ApplicationProtocol
+class AX_DLL Application : public ApplicationBase
 {
 public:
     Application();

core/renderer/QuadCommand.cpp

@@ -37,6 +37,12 @@ NS_AX_BEGIN
 int QuadCommand::__indexCapacity = -1;
 uint16_t* QuadCommand::__indices = nullptr;
 
+void QuadCommand::destroyIsolatedIndices()
+{
+    AX_SAFE_DELETE_ARRAY(__indices);
+    __indexCapacity = -1;
+}
+
 QuadCommand::QuadCommand() : _indexSize(-1), _ownedIndices() {}
 
 QuadCommand::~QuadCommand()

core/renderer/QuadCommand.h

@@ -67,6 +67,8 @@ class AX_DLL QuadCommand : public TrianglesCommand
               const Mat4& mv,
               uint32_t flags);
 
+    static void destroyIsolatedIndices();
+
 protected:
     void reIndex(int indices);
 

core/renderer/backend/DriverBase.h

@@ -82,6 +82,7 @@ class AX_DLL DriverBase : public ax::Ref
      * Returns a shared instance of the DriverBase.
      */
     static DriverBase* getInstance();
+    static void destroyInstance();
 
     virtual ~DriverBase() = default;
 

core/renderer/backend/ShaderCache.h

@@ -40,7 +40,7 @@ NS_AX_BACKEND_BEGIN
 /**
  * Create and reuse shader module.
  */
-class AX_DLL ShaderCache : public Ref
+class AX_DLL ShaderCache
 {
 public:
     static ShaderCache* getInstance();

core/renderer/backend/metal/DriverMTL.mm

@@ -391,10 +391,15 @@ bool supportS3TC(FeatureSet featureSet)
 
 DriverBase* DriverBase::getInstance()
 {
-    if (!DriverBase::_instance)
-        DriverBase::_instance = new DriverMTL();
+    if (!_instance)
+        _instance = new DriverMTL();
 
-    return DriverBase::_instance;
+    return _instance;
+}
+
+void DriverBase::destroyInstance() 
+{
+    AX_SAFE_DELETE(_instance);
 }
 
 void DriverMTL::setCAMetalLayer(CAMetalLayer* metalLayer)

core/renderer/backend/opengl/DriverGL.cpp

@@ -94,6 +94,10 @@ DriverBase* DriverBase::getInstance()
     return _instance;
 }
 
+void DriverBase::destroyInstance() {
+    AX_SAFE_DELETE(_instance);
+}
+
 DriverGL::DriverGL()
 {
     /// driver info

extensions/scripting/lua-bindings/script/core/Constants.lua

@@ -190,7 +190,7 @@ cc.UNIFORM_SAMPLER_S    = 'AX_Texture0'
 cc.UNIFORM_SIN_TIME_S   = 'AX_SinTime'
 cc.UNIFORM_TIME_S   = 'AX_Time'
 
--- refer to: ApplicationProtocol.h: enum class Platform
+-- refer to: ApplicationBase.h: enum class Platform
 cc.PLATFORM_UNKNOWN   = 0
 cc.PLATFORM_WIN32     = 1
 cc.PLATFORM_WINUWP    = 2