Ensure join of font thread 64/294664/3
authorBowon Ryu <bowon.ryu@samsung.com>
Thu, 22 Jun 2023 10:59:02 +0000 (19:59 +0900)
committerBowon Ryu <bowon.ryu@samsung.com>
Fri, 23 Jun 2023 11:00:19 +0000 (20:00 +0900)
In certain cases where the font thread is not joined,
such as when there is no UI or when the font client is not used.
this patch ensures the join of the font thread by invoking the join method in the destructor.

Change-Id: I8ffcf21ab9dcc1b1e4de54e50adb23d0796b996e
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
dali/devel-api/text-abstraction/font-client.cpp
dali/devel-api/text-abstraction/font-client.h
dali/internal/adaptor/common/application-impl.cpp
dali/internal/text/text-abstraction/font-client-impl.cpp
dali/internal/text/text-abstraction/font-client-impl.h
dali/internal/text/text-abstraction/plugin/font-client-plugin-cache-handler.cpp

index 5008e57..11ea888 100644 (file)
@@ -314,6 +314,11 @@ void FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList&
   Internal::FontClient::PreLoad(fontPathList, memoryFontPathList, useThread, syncCreation);
 }
 
+void FontClientJoinFontThreads()
+{
+  Internal::FontClient::JoinFontThreads();
+}
+
 } // namespace TextAbstraction
 
 } // namespace Dali
index 7a88e0a..ffe3f3b 100644 (file)
@@ -599,6 +599,11 @@ DALI_ADAPTOR_API void FontClientPreCache(const FontFamilyList& fallbackFamilyLis
  */
 DALI_ADAPTOR_API void FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread, bool syncCreation);
 
+/**
+  * @brief Joins font threads, waiting for their execution to complete.
+  */
+DALI_ADAPTOR_API void FontClientJoinFontThreads();
+
 } // namespace TextAbstraction
 
 } // namespace Dali
index fa6abcf..5fb0f6f 100644 (file)
@@ -346,6 +346,9 @@ void Application::OnInit()
   DALI_TRACE_END(gTraceFilter, "DALI_APP_EMIT_INIT_SIGNAL");
 
   mAdaptor->NotifySceneCreated();
+
+  // Ensure the join of Font thread at this point
+  Dali::TextAbstraction::FontClientJoinFontThreads();
 }
 
 void Application::OnTerminate()
index e8fd123..3b960a7 100644 (file)
@@ -57,9 +57,32 @@ namespace TextAbstraction
 {
 namespace Internal
 {
+class FontThread
+{
+/*
+ * There are cases in the candidate process where the font thread is
+ * no UI or when the font client is not used.
+ * In such cases, we can ensure the join of the font thread
+ * by calling the join method in the destructor of this class.
+ */
+public:
+  FontThread()
+  {
+  }
+  ~FontThread()
+  {
+    if(mThread.joinable())
+    {
+      mThread.join();
+    }
+  }
+  std::thread mThread;
+};
+
 Dali::TextAbstraction::FontClient FontClient::gPreCreatedFontClient(NULL);
-std::thread                       gPreCacheThread;
-std::thread                       gPreLoadThread;
+
+FontThread                        gPreCacheThread;
+FontThread                        gPreLoadThread;
 std::mutex                        gMutex;
 std::condition_variable           gPreCacheCond;
 std::condition_variable           gPreLoadCond;
@@ -101,17 +124,8 @@ Dali::TextAbstraction::FontClient FontClient::Get()
     }
     else // create and register the object
     {
-      if(gPreCacheThread.joinable())
-      {
-        gPreCacheThread.join();
-        FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "FontClient PreCache thread join\n");
-      }
-
-      if(gPreLoadThread.joinable())
-      {
-        gPreLoadThread.join();
-        FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "FontClient PreLoad thread join\n");
-      }
+      // Check the joinable status of PreCahe and PreLoad thread, and join them
+      JoinFontThreads();
 
       if(gPreCreatedFontClient)
       {
@@ -205,9 +219,10 @@ void FontClient::PreCache(const FontFamilyList& fallbackFamilyList, const FontFa
     return;
   }
 
-  if(gPreCacheThread.joinable())
+  if(gPreCacheThread.mThread.joinable())
   {
     FONT_LOG_MESSAGE(Dali::Integration::Log::ERROR, "FontClient pre-cache thread already running.\n");
+    return;
   }
 
   if(!gPreCreatedFontClient)
@@ -232,13 +247,13 @@ void FontClient::PreCache(const FontFamilyList& fallbackFamilyList, const FontFa
       gPreCacheThreadReady = false;
       std::unique_lock<std::mutex> lock(gMutex);
       FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "BEGIN: DALI_TEXT_PRECACHE_THREAD_SYNC_CREATION\n");
-      gPreCacheThread = std::thread(PreCacheRun, fallbackFamilyList, extraFamilyList, localeFamily, syncCreation);
+      gPreCacheThread.mThread = std::thread(PreCacheRun, fallbackFamilyList, extraFamilyList, localeFamily, syncCreation);
       gPreCacheCond.wait_for(lock, timeout, []{return gPreCacheThreadReady;});
       FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "END: DALI_TEXT_PRECACHE_THREAD_SYNC_CREATION\n");
     }
     else
     {
-      gPreCacheThread = std::thread(PreCacheRun, fallbackFamilyList, extraFamilyList, localeFamily, syncCreation);
+      gPreCacheThread.mThread = std::thread(PreCacheRun, fallbackFamilyList, extraFamilyList, localeFamily, syncCreation);
     }
   }
   else
@@ -255,7 +270,7 @@ void FontClient::PreLoad(const FontPathList& fontPathList, const FontPathList& m
     return;
   }
 
-  if(gPreLoadThread.joinable())
+  if(gPreLoadThread.mThread.joinable())
   {
     FONT_LOG_MESSAGE(Dali::Integration::Log::ERROR, "FontClient font pre-load thread already running.\n");
     return;
@@ -282,13 +297,13 @@ void FontClient::PreLoad(const FontPathList& fontPathList, const FontPathList& m
       gPreLoadThreadReady = false;
       std::unique_lock<std::mutex> lock(gMutex);
       FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "BEGIN: DALI_TEXT_FONT_PRELOAD_THREAD_SYNC_CREATION\n");
-      gPreLoadThread = std::thread(PreLoadRun, fontPathList, memoryFontPathList, syncCreation);
+      gPreLoadThread.mThread = std::thread(PreLoadRun, fontPathList, memoryFontPathList, syncCreation);
       gPreLoadCond.wait_for(lock, timeout, []{return gPreLoadThreadReady;});
       FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "END: DALI_TEXT_FONT_PRELOAD_THREAD_SYNC_CREATION\n");
     }
     else
     {
-      gPreLoadThread = std::thread(PreLoadRun, fontPathList, memoryFontPathList, syncCreation);
+      gPreLoadThread.mThread = std::thread(PreLoadRun, fontPathList, memoryFontPathList, syncCreation);
     }
   }
   else
@@ -297,6 +312,21 @@ void FontClient::PreLoad(const FontPathList& fontPathList, const FontPathList& m
   }
 }
 
+void FontClient::JoinFontThreads()
+{
+  if(gPreCacheThread.mThread.joinable())
+  {
+    gPreCacheThread.mThread.join();
+    FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "FontClient PreCache thread join\n");
+  }
+
+  if(gPreLoadThread.mThread.joinable())
+  {
+    gPreLoadThread.mThread.join();
+    FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "FontClient PreLoad thread join\n");
+  }
+}
+
 void FontClient::ClearCache()
 {
   if(mPlugin)
index 79e1ab9..ca7fe5e 100644 (file)
@@ -88,6 +88,11 @@ public: // API for Dali::TextAbstraction::FontClient used.
   static void PreLoadRun(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool syncCreation);
 
   /**
+   * @brief Joins font threads, waiting for their execution to complete.
+   */
+  static void JoinFontThreads();
+
+  /**
    * @copydoc Dali::TextAbstraction::FontClient::ClearCache()
    */
   void ClearCache();
index c248787..2509c8d 100644 (file)
@@ -604,7 +604,7 @@ bool FontClient::Plugin::CacheHandler::LoadFontDataFromFile(const std::string& f
 {
   if(Dali::FileLoader::ReadFile(fontPath, dataSize, fontDataBuffer, Dali::FileLoader::BINARY))
   {
-    FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "PreLoad font file buffer : %lu, size : %ld, path : %s\n", fontDataBuffer.Size(), static_cast<long>(dataSize), fontPath.c_str());
+    FONT_LOG_MESSAGE(Dali::Integration::Log::INFO, "PreLoad font file buffer : %zu, size : %ld, path : %s\n", fontDataBuffer.Size(), static_cast<long>(dataSize), fontPath.c_str());
     return true;
   }