[Tizen] Add support for FontClientFontPreLoad API

[platform/core/uifw/dali-adaptor.git] / dali / internal / text / text-abstraction / font-client-impl.h

diff --git a/dali/internal/text/text-abstraction/font-client-impl.h b/dali/internal/text/text-abstraction/font-client-impl.h
index 07eea78..d0f7494 100644 (file)
--- a/dali/internal/text/text-abstraction/font-client-impl.h
+++ b/dali/internal/text/text-abstraction/font-client-impl.h
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H
 
 /*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -32,6 +32,8 @@ namespace TextAbstraction
 {
 namespace Internal
 {
+using HarfBuzzFontHandle = void*; ///< @note We don't want to make other class include harfbuzz header. So we will keep harfbuzz font data as HarfBuzzFontHandle.
+
 /**
  * Implementation of the FontClient
  */
@@ -48,6 +50,7 @@ public:
    */
   ~FontClient();
 
+public: // API for Dali::TextAbstraction::FontClient used.
   /**
    * @copydoc Dali::TextAbstraction::FontClient::Get()
    */
@@ -61,6 +64,30 @@ public:
   static Dali::TextAbstraction::FontClient PreInitialize();
 
   /**
+   * @brief This is used to pre-cache FontConfig in order to improve the runtime performance of the application.
+   *
+   * @see Dali::TextAbstraction::FontClientPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily, bool useThread);
+   */
+  static void PreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily, bool useThread);
+
+  /**
+   * @brief This is used to creates a global font client and pre-caches the FontConfig.
+   */
+  static void PreCacheRun(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily);
+
+  /**
+   * @brief This is used to pre-load FreeType font face in order to improve the runtime performance of the application.
+   *
+   * @see Dali::TextAbstraction:FontClientFontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread);
+   */
+  static void PreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList, bool useThread);
+
+  /**
+   * @brief This is used to creates a global font client and pre-loads the FreeType font face.
+   */
+  static void PreLoadRun(const FontPathList& fontPathList, const FontPathList& memoryFontPathList);
+
+  /**
    * @copydoc Dali::TextAbstraction::FontClient::ClearCache()
    */
   void ClearCache();
@@ -91,6 +118,11 @@ public:
   void GetDefaultFonts(FontList& defaultFonts);
 
   /**
+   * @copydoc Dali::TextAbstraction::FontClient::InitDefaultFontDescription()
+   */
+  void InitDefaultFontDescription();
+
+  /**
    * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
    */
   void GetDefaultPlatformFontDescription(FontDescription& fontDescription);
@@ -103,12 +135,12 @@ public:
   /**
    * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
    */
-  void GetDescription(FontId id, FontDescription& fontDescription);
+  void GetDescription(FontId fontId, FontDescription& fontDescription);
 
   /**
    * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
    */
-  PointSize26Dot6 GetPointSize(FontId id);
+  PointSize26Dot6 GetPointSize(FontId fontId);
 
   /**
    * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
@@ -184,6 +216,11 @@ public:
   GlyphIndex GetGlyphIndex(FontId fontId, Character charcode);
 
   /**
+   * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
+   */
+  GlyphIndex GetGlyphIndex(FontId fontId, Character charcode, Character variantSelector);
+
+  /**
    * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
    */
   bool GetGlyphMetrics(GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal);
@@ -233,7 +270,7 @@ public:
    */
   Size GetMaximumTextAtlasSize() const;
 
-   /**
+  /**
    * @copydoc Dali::TextAbstraction::FontClient::GetDefaultTextAtlasSize()
    */
   Size GetDefaultTextAtlasSize() const;
@@ -254,6 +291,12 @@ public:
   uint32_t GetNumberOfPointsPerOneUnitOfPointSize() const;
 
   /**
+   * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
+   */
+  bool AddCustomFontDirectory(const FontPath& path);
+
+public: // API for Dali::TextAbstraction::Internal::FontClient used.
+  /**
    * @brief Retrieves the pointer to the FreeType Font Face for the given @p fontId.
    *
    * @param[in] fontId The font id.
@@ -272,9 +315,31 @@ public:
   FontDescription::Type GetFontType(FontId fontId);
 
   /**
-   * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
+   * @brief Get the harfbuzz font data of font.
+   *
+   * @param fontId The font id.
+   * @return The harfbuzz font data, or nullptr if failed.
    */
-  bool AddCustomFontDirectory(const FontPath& path);
+  HarfBuzzFontHandle GetHarfBuzzFont(FontId fontId);
+
+  /**
+   * @brief This is used to pre-cache fonts in order to improve the runtime performance of the application.
+   *
+   * @param[in] fallbackFamilyList A list of fallback font families to be pre-cached.
+   * @param[in] extraFamilyList A list of additional font families to be pre-cached.
+   * @param[in] localeFamily A locale font family to be pre-cached.
+   */
+  void FontPreCache(const FontFamilyList& fallbackFamilyList, const FontFamilyList& extraFamilyList, const FontFamily& localeFamily);
+
+  /**
+   * @brief This is used to pre-load FreeType font face in order to improve the runtime performance of the application.
+   *
+   * @param[in] fontPathList A list of font paths to be pre-loaded.
+   * @param[in] memoryFontPathList A list of memory font paths to be pre-loaded.
+   * @param[in] useThread True if the font client should create thread and perform font pre-loading, false otherwise.
+   */
+  void FontPreLoad(const FontPathList& fontPathList, const FontPathList& memoryFontPathList);
+
 
 private:
   /**
@@ -296,7 +361,7 @@ private:
   unsigned int mDpiHorizontal;
   unsigned int mDpiVertical;
 
-  static Dali::TextAbstraction::FontClient gPreInitializedFontClient;
+  static Dali::TextAbstraction::FontClient gPreCreatedFontClient;
 
 }; // class FontClient