text/dali/internal/text-abstraction/font-client-plugin-impl.h

   1 #ifndef __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H__
   2 #define __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/devel-api/text-abstraction/font-metrics.h>
  23 #include <dali/devel-api/text-abstraction/glyph-info.h>
  24 #include <dali/internal/text-abstraction/font-client-impl.h>
  25
  26 #ifdef ENABLE_VECTOR_BASED_TEXT_RENDERING
  27 #include <dali/internal/glyphy/vector-font-cache.h>
  28 #else
  29 class VectorFontCache;
  30 #endif
  31
  32 // EXTERNAL INCLUDES
  33 #include <ft2build.h>
  34 #include FT_FREETYPE_H
  35 #include FT_GLYPH_H
  36
  37 // forward declarations of font config types.
  38 struct _FcFontSet;
  39 struct _FcPattern;
  40
  41 namespace Dali
  42 {
  43
  44 namespace TextAbstraction
  45 {
  46
  47 namespace Internal
  48 {
  49
  50 /**
  51  *@brief Type used for indices addressing the vector with front descriptions of validated fonts.
  52  */
  53 typedef uint32_t FontDescriptionId;
  54
  55 /**
  56  * @brief FontClient implementation.
  57  */
  58 struct FontClient::Plugin
  59 {
  60   /**
  61    * @brief Caches an list of fallback fonts for a given font-description
  62    */
  63   struct FallbackCacheItem
  64   {
  65     FallbackCacheItem( const FontDescription& fontDescription, FontList* fallbackFonts );
  66
  67     FontDescription fontDescription; ///< The font description.
  68     FontList* fallbackFonts;         ///< The list of fallback fonts for the given font-description.
  69   };
  70
  71   /**
  72    * @brief Caches an index to the vector of font descriptions for a given font.
  73    */
  74   struct FontDescriptionCacheItem
  75   {
  76     FontDescriptionCacheItem( const FontDescription& fontDescription,
  77                               FontDescriptionId index );
  78
  79     FontDescription fontDescription; ///< The font description.
  80     FontDescriptionId index;         ///< Index to the vector of font descriptions.
  81   };
  82
  83   /**
  84    * @brief Caches the font id of the pair font point size and the index to the vector of font descriptions of validated fonts.
  85    */
  86   struct FontIdCacheItem
  87   {
  88     FontIdCacheItem( FontDescriptionId validatedFontId,
  89                      PointSize26Dot6 requestedPointSize,
  90                      FontId fontId );
  91
  92     FontDescriptionId validatedFontId;    ///< Index to the vector with font descriptions.
  93     PointSize26Dot6   requestedPointSize; ///< The font point size.
  94     FontId            fontId;             ///< The font id.
  95   };
  96
  97   /**
  98    * @brief Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
  99    */
 100   struct CacheItem
 101   {
 102     CacheItem( FT_Face ftFace,
 103                const FontPath& path,
 104                PointSize26Dot6 requestedPointSize,
 105                FaceIndex face,
 106                const FontMetrics& metrics );
 107
 108     CacheItem( FT_Face ftFace,
 109                const FontPath& path,
 110                PointSize26Dot6 requestedPointSize,
 111                FaceIndex face,
 112                const FontMetrics& metrics,
 113                float fixedWidth,
 114                float fixedHeight );
 115
 116     FT_Face mFreeTypeFace;               ///< The FreeType face.
 117     FontPath mPath;                      ///< The path to the font file name.
 118     PointSize26Dot6 mRequestedPointSize; ///< The font point size.
 119     FaceIndex mFaceIndex;                ///< The face index.
 120     FontMetrics mMetrics;                ///< The font metrics.
 121     FT_Short mFixedWidthPixels;          ///< The height in pixels (fixed size bitmaps only)
 122     FT_Short mFixedHeightPixels;         ///< The height in pixels (fixed size bitmaps only)
 123     unsigned int mVectorFontId;          ///< The ID of the equivalent vector-based font
 124     bool mIsFixedSizeBitmap;             ///< Whether the font has fixed size bitmaps.
 125   };
 126
 127   struct EllipsisItem
 128   {
 129     PointSize26Dot6 requestedPointSize;
 130     GlyphInfo glyph;
 131   };
 132
 133   /**
 134    * Constructor.
 135    *
 136    * Initializes the FreeType library.
 137    * Initializes the dpi values.
 138    *
 139    * @param[in] horizontalDpi The horizontal dpi.
 140    * @param[in] verticalDpi The vertical dpi.
 141    */
 142   Plugin( unsigned int horizontalDpi, unsigned int verticalDpi );
 143
 144   /**
 145    * Default destructor.
 146    *
 147    * Frees any allocated resource.
 148    */
 149   ~Plugin();
 150
 151   /**
 152    * @copydoc Dali::FontClient::SetDpi()
 153    */
 154   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 155
 156   /**
 157    * @copydoc Dali::FontClient::ResetSystemDefaults()
 158    */
 159   void ResetSystemDefaults();
 160
 161   /**
 162    * @copydoc Dali::FontClient::SetDefaultFont()
 163    */
 164   void SetDefaultFont( const FontDescription& fontDescription );
 165
 166   /**
 167    * @copydoc Dali::FontClient::GetDefaultPlatformFontDescription()
 168    */
 169   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
 170
 171   /**
 172    * @copydoc Dali::FontClient::GetDefaultFonts()
 173    */
 174   void GetDefaultFonts( FontList& defaultFonts );
 175
 176   /**
 177    * @copydoc Dali::FontClient::GetSystemFonts()
 178    */
 179   void GetSystemFonts( FontList& systemFonts );
 180
 181   /**
 182    * @copydoc Dali::FontClient::GetDescription()
 183    */
 184   void GetDescription( FontId id, FontDescription& fontDescription ) const;
 185
 186   /**
 187    * @copydoc Dali::FontClient::GetPointSize()
 188    */
 189   PointSize26Dot6 GetPointSize( FontId id );
 190
 191   /**
 192    * @copydoc Dali::FontClient::FindFontForCharacter()
 193    */
 194   FontId FindFontForCharacter( const FontList& fontList,
 195                                Character charcode,
 196                                PointSize26Dot6 requestedPointSize,
 197                                bool preferColor );
 198
 199   /**
 200    * @copydoc Dali::FontClient::FindDefaultFont()
 201    */
 202   FontId FindDefaultFont( Character charcode, PointSize26Dot6 requestedPointSize, bool preferColor );
 203
 204   /**
 205    * @copydoc Dali::FontClient::FindFallbackFont()
 206    */
 207   FontId FindFallbackFont( FontId preferredFont, Character charcode, PointSize26Dot6 requestedPointSize, bool preferColor );
 208
 209   /**
 210    * @see Dali::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
 211    *
 212    * @param[in] actualPointSize The actual point size. In case of emojis the @p requestedPointSize is used to build the metrics and cache the font and the @p actualPointSize is used to load the glyph.
 213    * @param[in] cacheDescription Whether to cache the font description.
 214    */
 215   FontId GetFontId( const FontPath& path,
 216                     PointSize26Dot6 requestedPointSize,
 217                     PointSize26Dot6 actualPointSize,
 218                     FaceIndex faceIndex,
 219                     bool cacheDescription = true );
 220
 221   /**
 222    * @copydoc Dali::FontClient::GetFontId( const FontDescription& fontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
 223    */
 224   FontId GetFontId( const FontDescription& fontDescription,
 225                     PointSize26Dot6 requestedPointSize,
 226                     PointSize26Dot6 actualPointSize,
 227                     FaceIndex faceIndex );
 228
 229   /**
 230    * @copydoc Dali::FontClient::IsScalable( const FontPath& path )
 231    */
 232   bool IsScalable( const FontPath& path );
 233
 234   /**
 235    * @copydoc Dali::FontClient::IsScalable( const FontDescription& fontDescription )
 236    */
 237   bool IsScalable( const FontDescription& fontDescription );
 238
 239   /**
 240    * @copydoc Dali::FontClient::GetFixedSizes()
 241    */
 242   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
 243
 244   /**
 245    * @copydoc Dali::FontClient::GetFixedSizes()
 246    */
 247   void GetFixedSizes( const FontDescription& fontDescription,
 248                       Dali::Vector< PointSize26Dot6 >& sizes );
 249
 250   /**
 251    * @copydoc Dali::FontClient::GetFontMetrics()
 252    */
 253   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
 254
 255   /**
 256    * @copydoc Dali::FontClient::GetGlyphIndex()
 257    */
 258   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 259
 260   /**
 261    * @copydoc Dali::FontClient::GetGlyphMetrics()
 262    */
 263   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal );
 264
 265   /**
 266    * Helper for GetGlyphMetrics when using bitmaps
 267    */
 268   bool GetBitmapMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
 269
 270   /**
 271    * Helper for GetGlyphMetrics when using vectors
 272    */
 273   bool GetVectorMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
 274
 275   /**
 276    * @copydoc Dali::FontClient::CreateBitmap()
 277    */
 278   BufferImage CreateBitmap( FontId fontId, GlyphIndex glyphIndex );
 279
 280   /**
 281    * @copydoc Dali::FontClient::CreateVectorBlob()
 282    */
 283   void CreateVectorBlob( FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight );
 284
 285   /**
 286    * @copydoc Dali::FontClient::GetEllipsisGlyph()
 287    */
 288   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
 289
 290 private:
 291
 292   /**
 293    * Caches the fonts present in the platform.
 294    *
 295    * Calls GetFcFontSet() to retrieve the fonts.
 296    */
 297   void InitSystemFonts();
 298
 299   /**
 300    * Gets the FontDescription which matches the given pattern
 301    * @param[in] pattern pattern to match against
 302    * @param[out] fontDescription the resultant fontDescription that matched
 303    * @return true if match found
 304    */
 305   bool MatchFontDescriptionToPattern( _FcPattern* pattern, Dali::TextAbstraction::FontDescription& fontDescription );
 306
 307   /**
 308    * @brief Creates a font family pattern used to match fonts.
 309    *
 310    * @param[in] fontDescription The font to cache.
 311    *
 312    * @return The pattern.
 313    */
 314   _FcPattern* CreateFontFamilyPattern( const FontDescription& fontDescription );
 315
 316   /**
 317    * Retrieves the fonts present in the platform.
 318    *
 319    * @return A font fonfig data structure with the platform's fonts.
 320    */
 321   _FcFontSet* GetFcFontSet() const;
 322
 323   /**
 324    * Retrieves a font config object's value from a pattern.
 325    *
 326    * @param[in] pattern The font config pattern.
 327    * @param[in] n The object.
 328    * @param[out] string The object's value.
 329    *
 330    * @return @e true if the operation is successful.
 331    */
 332   bool GetFcString( const _FcPattern* const pattern, const char* const n, std::string& string );
 333
 334   /**
 335    * Retrieves a font config object's value from a pattern.
 336    *
 337    * @param[in] pattern The font config pattern.
 338    * @param[in] n The object.
 339    * @param[out] intVal The object's value.
 340    *
 341    * @return @e true if the operation is successful.
 342    */
 343   bool GetFcInt( const _FcPattern* const pattern, const char* const n, int& intVal );
 344
 345   /**
 346    * @brief Creates a font.
 347    *
 348    * @param[in] path The path to the font file name.
 349    * @param[in] requestedPointSize The requested point size.
 350    * @param[in] actualPointSize The actual point size (for color emojis).
 351    * @param[in] faceIndex A face index.
 352    * @param[in] cacheDescription Whether to cache the font description.
 353    *
 354    * @return The font id.
 355    */
 356   FontId CreateFont( const FontPath& path,
 357                      PointSize26Dot6 requestedPointSize,
 358                      PointSize26Dot6 actualPointSize,
 359                      FaceIndex faceIndex,
 360                      bool cacheDescription );
 361
 362   /**
 363    *
 364    * @param[in] destBitmap
 365    * @param[in] srcBitmap
 366    */
 367   void ConvertBitmap( BufferImage& destBitmap, FT_Bitmap srcBitmap );
 368
 369   /**
 370    * @brief Finds in the cache if there is a triplet with the path to the font file name, the font point size and the face index.
 371    * If there is one , if writes the font id in the param @p fontId.
 372    *
 373    * @param[in] path Path to the font file name.
 374    * @param[in] requestedPointSize The font point size.
 375    * @param[in] faceIndex The face index.
 376    * @param[out] fontId The font id.
 377    *
 378    * @return @e true if there triplet is found.
 379    */
 380   bool FindFont( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex, FontId& fontId ) const;
 381
 382   /**
 383    * @brief Finds in the cache a cluster 'font family, font width, font weight, font slant'
 384    * If there is one, it writes the index to the vector with font descriptions in the param @p validatedFontId.
 385    *
 386    * @param[in] fontDescription The font to validate.
 387    * @param[out] validatedFontId The index to the vector with font descriptions.
 388    *
 389    * @return @e true if the pair is found.
 390    */
 391   bool FindValidatedFont( const FontDescription& fontDescription,
 392                           FontDescriptionId& validatedFontId );
 393
 394   /**
 395    * @brief Finds a fallback font list from the cache for a given font-description
 396    *
 397    * @param[in] fontDescription The font to validate.
 398    * @param[out] A valid pointer to a font list, or NULL if not found.
 399    */
 400   bool FindFallbackFontList( const FontDescription& fontDescription,
 401                              FontList*& fontList );
 402
 403   /**
 404    * @brief Finds in the cache a pair 'validated font id and font point size'.
 405    * If there is one it writes the font id in the param @p fontId.
 406    *
 407    * @param[in] validatedFontId Index to the vector with font descriptions.
 408    * @param[in] requestedPointSize The font point size.
 409    * @param[out] fontId The font id.
 410    *
 411    * @return @e true if the pair is found.
 412    */
 413   bool FindFont( FontDescriptionId validatedFontId,
 414                  PointSize26Dot6 requestedPointSize,
 415                  FontId& fontId );
 416
 417   /**
 418    * @brief Validate a font description.
 419    *
 420    * @param[in] fontDescription The font to validate.
 421    * @param[out] validatedFontId Result of validation
 422    */
 423   void ValidateFont( const FontDescription& fontDescription,
 424                      FontDescriptionId& validatedFontId );
 425
 426   /**
 427    * Helper for GetDefaultFonts etc.
 428    *
 429    * @param[in] fontDescription A font description.
 430    * @param[out] fontList A list of the fonts which are a close match for fontDescription.
 431    */
 432   void SetFontList( const FontDescription& fontDescription, FontList& fontList );
 433
 434   /**
 435    * Caches a font path.
 436    *
 437    * @param[in] ftFace The FreeType face.
 438    * @param[in] id The font identifier.
 439    * @param[in] requestedPointSize The font point size.
 440    * @param[in] path Path to the font file name.
 441    */
 442   void CacheFontPath( FT_Face ftFace, FontId id, PointSize26Dot6 requestedPointSize,  const FontPath& path );
 443
 444 private:
 445
 446   // Declared private and left undefined to avoid copies.
 447   Plugin( const Plugin& );
 448   // Declared private and left undefined to avoid copies.
 449   Plugin& operator=( const Plugin& );
 450
 451 private:
 452
 453   FT_Library mFreeTypeLibrary; ///< A handle to a FreeType library instance.
 454
 455   unsigned int mDpiHorizontal; ///< Horizontal dpi.
 456   unsigned int mDpiVertical;   ///< Vertical dpi.
 457
 458   FontDescription mDefaultFontDescription; ///< The cached default font from the system
 459
 460   FontList mSystemFonts;       ///< Cached system fonts.
 461   FontList mDefaultFonts;      ///< Cached default fonts.
 462
 463   std::vector<FallbackCacheItem> mFallbackCache; ///< Cached fallback font lists.
 464
 465   std::vector<CacheItem>                mFontCache;            ///< Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
 466   std::vector<FontDescriptionCacheItem> mValidatedFontCache;   ///< Caches indices to the vector of font descriptions for a given font.
 467   FontList                              mFontDescriptionCache; ///< Caches font descriptions for the validated font.
 468   std::vector<FontIdCacheItem>          mFontIdCache;          ///< Caches font ids for the pairs of font point size and the index to the vector with font descriptions of the validated fonts.
 469
 470   VectorFontCache* mVectorFontCache; ///< Separate cache for vector data blobs etc.
 471
 472   Vector<EllipsisItem> mEllipsisCache;      ///< Caches ellipsis glyphs for a particular point size.
 473
 474   bool mDefaultFontDescriptionCached : 1; ///< Whether the default font is cached or not
 475 };
 476
 477 } // namespace Internal
 478
 479 } // namespace TextAbstraction
 480
 481 } // namespace Dali
 482
 483 #endif // __DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H__