1 #ifndef DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H
2 #define DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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/text-abstraction/font-client-impl.h>
26 #ifdef ENABLE_VECTOR_BASED_TEXT_RENDERING
27 #include <dali/internal/text/glyphy/vector-font-cache.h>
29 class VectorFontCache;
34 #include FT_FREETYPE_H
38 #include FT_SYNTHESIS_H
40 // forward declarations of font config types.
48 namespace TextAbstraction
55 *@brief Type used for indices addressing the vector with front descriptions of validated fonts.
57 typedef uint32_t FontDescriptionId;
58 typedef Vector<_FcCharSet*> CharacterSetList;
61 * @brief FontClient implementation.
63 struct FontClient::Plugin
66 * @brief Caches an list of fallback fonts for a given font-description
68 struct FallbackCacheItem
70 FallbackCacheItem( FontDescription&& fontDescription, FontList* fallbackFonts, CharacterSetList* characterSets );
72 FontDescription fontDescription; ///< The font description.
73 FontList* fallbackFonts; ///< The list of fallback fonts for the given font-description.
74 CharacterSetList* characterSets; ///< The list of character sets for the given font-description.
78 * @brief Caches an index to the vector of font descriptions for a given font.
80 struct FontDescriptionCacheItem
82 FontDescriptionCacheItem( const FontDescription& fontDescription,
83 FontDescriptionId index );
84 FontDescriptionCacheItem( FontDescription&& fontDescription,
85 FontDescriptionId index );
87 FontDescription fontDescription; ///< The font description.
88 FontDescriptionId index; ///< Index to the vector of font descriptions.
92 * @brief Caches the font id of the pair font point size and the index to the vector of font descriptions of validated fonts.
94 struct FontDescriptionSizeCacheItem
96 FontDescriptionSizeCacheItem( FontDescriptionId validatedFontId,
97 PointSize26Dot6 requestedPointSize,
100 FontDescriptionId validatedFontId; ///< Index to the vector with font descriptions.
101 PointSize26Dot6 requestedPointSize; ///< The font point size.
102 FontId fontId; ///< The font identifier.
106 * @brief Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
108 struct FontFaceCacheItem
110 FontFaceCacheItem( FT_Face ftFace,
111 const FontPath& path,
112 PointSize26Dot6 requestedPointSize,
114 const FontMetrics& metrics );
116 FontFaceCacheItem( FT_Face ftFace,
117 const FontPath& path,
118 PointSize26Dot6 requestedPointSize,
120 const FontMetrics& metrics,
123 bool hasColorTables );
125 FT_Face mFreeTypeFace; ///< The FreeType face.
126 FontPath mPath; ///< The path to the font file name.
127 PointSize26Dot6 mRequestedPointSize; ///< The font point size.
128 FaceIndex mFaceIndex; ///< The face index.
129 FontMetrics mMetrics; ///< The font metrics.
130 _FcCharSet* mCharacterSet; ///< Pointer with the range of characters.
131 FT_Short mFixedWidthPixels; ///< The height in pixels (fixed size bitmaps only)
132 FT_Short mFixedHeightPixels; ///< The height in pixels (fixed size bitmaps only)
133 unsigned int mVectorFontId; ///< The ID of the equivalent vector-based font
134 bool mIsFixedSizeBitmap : 1; ///< Whether the font has fixed size bitmaps.
135 bool mHasColorTables : 1; ///< Whether the font has color tables.
140 PointSize26Dot6 requestedPointSize;
147 * Initializes the FreeType library.
148 * Initializes the dpi values.
150 * @param[in] horizontalDpi The horizontal dpi.
151 * @param[in] verticalDpi The vertical dpi.
153 Plugin( unsigned int horizontalDpi, unsigned int verticalDpi );
156 * Default destructor.
158 * Frees any allocated resource.
163 * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
165 void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
168 * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
170 void ResetSystemDefaults();
173 * @copydoc Dali::TextAbstraction::FontClient::SetDefaultFont()
175 void SetDefaultFont( const FontDescription& preferredFontDescription );
178 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
180 void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
183 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
185 void GetDefaultFonts( FontList& defaultFonts );
188 * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
190 void GetSystemFonts( FontList& systemFonts );
193 * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
195 void GetDescription( FontId id, FontDescription& fontDescription ) const;
198 * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
200 PointSize26Dot6 GetPointSize( FontId id );
203 * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
205 bool IsCharacterSupportedByFont( FontId fontId, Character character );
208 * @brief Finds within the @p fontList a font which support the @p carcode.
210 * @param[in] fontList A list of font paths, family, width, weight and slant.
211 * @param[in] characterSetList A list that contains a character set for each description of the font list.
212 * @param[in] charcode The character for which a font is needed.
213 * @param[in] requestedPointSize The point size in 26.6 fractional points.
214 * @param[in] preferColor @e true if a color font is preferred.
216 * @return A valid font identifier, or zero if no font is found.
218 FontId FindFontForCharacter( const FontList& fontList,
219 const CharacterSetList& characterSetList,
221 PointSize26Dot6 requestedPointSize,
225 * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
227 FontId FindDefaultFont( Character charcode,
228 PointSize26Dot6 requestedPointSize,
232 * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
234 FontId FindFallbackFont( Character charcode,
235 const FontDescription& preferredFontDescription,
236 PointSize26Dot6 requestedPointSize,
240 * @see Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
242 * @param[in] cacheDescription Whether to cache the font description.
244 FontId GetFontId( const FontPath& path,
245 PointSize26Dot6 requestedPointSize,
247 bool cacheDescription );
250 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& preferredFontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
252 FontId GetFontId( const FontDescription& fontDescription,
253 PointSize26Dot6 requestedPointSize,
254 FaceIndex faceIndex );
257 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
259 bool IsScalable( const FontPath& path );
262 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
264 bool IsScalable( const FontDescription& fontDescription );
267 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
269 void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
272 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
274 void GetFixedSizes( const FontDescription& fontDescription,
275 Dali::Vector< PointSize26Dot6 >& sizes );
278 * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
280 void GetFontMetrics( FontId fontId, FontMetrics& metrics );
283 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
285 GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
288 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
290 bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal );
293 * Helper for GetGlyphMetrics when using bitmaps
295 bool GetBitmapMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
298 * Helper for GetGlyphMetrics when using vectors
300 bool GetVectorMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
303 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool softwareItalic, bool softwareBold, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
305 void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool softwareItalic, bool softwareBold, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth );
308 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
310 PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
313 * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
315 void CreateVectorBlob( FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight );
318 * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
320 const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
323 * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
325 bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
328 * @copydoc Dali::TextAbstraction::Internal::FontClient::GetFreetypeFace()
330 FT_FaceRec_* GetFreetypeFace( FontId fontId );
333 * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
335 bool AddCustomFontDirectory( const FontPath& path );
340 * @brief Caches the fonts present in the platform.
342 * Calls GetFcFontSet() to retrieve the fonts.
344 void InitSystemFonts();
347 * @brief Gets the FontDescription which matches the given pattern.
348 * @param[in] pattern pattern to match against.
349 * @param[out] fontDescription the resultant fontDescription that matched.
350 * @param[out] characterSet The character set for that pattern.
351 * @return true if match found.
353 bool MatchFontDescriptionToPattern( _FcPattern* pattern, Dali::TextAbstraction::FontDescription& fontDescription, _FcCharSet** characterSet );
356 * @brief Creates a font family pattern used to match fonts.
358 * @param[in] fontDescription The font to cache.
360 * @return The pattern.
362 _FcPattern* CreateFontFamilyPattern( const FontDescription& fontDescription ) const;
365 * Retrieves the fonts present in the platform.
367 * @return A font fonfig data structure with the platform's fonts.
369 _FcFontSet* GetFcFontSet() const;
372 * Retrieves a font config object's value from a pattern.
374 * @param[in] pattern The font config pattern.
375 * @param[in] n The object.
376 * @param[out] string The object's value.
378 * @return @e true if the operation is successful.
380 bool GetFcString( const _FcPattern* const pattern, const char* const n, std::string& string );
383 * Retrieves a font config object's value from a pattern.
385 * @param[in] pattern The font config pattern.
386 * @param[in] n The object.
387 * @param[out] intVal The object's value.
389 * @return @e true if the operation is successful.
391 bool GetFcInt( const _FcPattern* const pattern, const char* const n, int& intVal );
394 * @brief Creates a font.
396 * @param[in] path The path to the font file name.
397 * @param[in] requestedPointSize The requested point size.
398 * @param[in] faceIndex A face index.
399 * @param[in] cacheDescription Whether to cache the font description.
401 * @return The font identifier.
403 FontId CreateFont( const FontPath& path,
404 PointSize26Dot6 requestedPointSize,
406 bool cacheDescription );
409 * @brief Copy the FreeType bitmap to the given buffer.
411 * @param[out] data The bitmap data.
412 * @param[in] srcBitmap The FreeType bitmap.
414 void ConvertBitmap( TextAbstraction::FontClient::GlyphBufferData& data, FT_Bitmap srcBitmap );
417 * @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.
418 * If there is one , if writes the font identifier in the param @p fontId.
420 * @param[in] path Path to the font file name.
421 * @param[in] requestedPointSize The font point size.
422 * @param[in] faceIndex The face index.
423 * @param[out] fontId The font identifier.
425 * @return @e true if there triplet is found.
427 bool FindFont( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex, FontId& fontId ) const;
430 * @brief Finds in the cache a cluster 'font family, font width, font weight, font slant'
431 * If there is one, it writes the index to the vector with font descriptions in the param @p validatedFontId.
433 * @param[in] fontDescription The font to validate.
434 * @param[out] validatedFontId The index to the vector with font descriptions.
436 * @return @e true if the pair is found.
438 bool FindValidatedFont( const FontDescription& fontDescription,
439 FontDescriptionId& validatedFontId );
442 * @brief Finds a fallback font list from the cache for a given font-description
444 * @param[in] fontDescription The font to validate.
445 * @param[out] A valid pointer to a font list, or @e nullptr if not found.
446 * @param[out] characterSetList A valid pointer to a character set list, or @e nullptr if not found.
448 bool FindFallbackFontList( const FontDescription& fontDescription,
450 CharacterSetList*& characterSetList );
453 * @brief Finds in the cache a pair 'validated font identifier and font point size'.
454 * If there is one it writes the font identifier in the param @p fontId.
456 * @param[in] validatedFontId Index to the vector with font descriptions.
457 * @param[in] requestedPointSize The font point size.
458 * @param[out] fontId The font identifier.
460 * @return @e true if the pair is found.
462 bool FindFont( FontDescriptionId validatedFontId,
463 PointSize26Dot6 requestedPointSize,
467 * @brief Validate a font description.
469 * @param[in] fontDescription The font to validate.
470 * @param[out] validatedFontId Result of validation
472 void ValidateFont( const FontDescription& fontDescription,
473 FontDescriptionId& validatedFontId );
476 * Helper for GetDefaultFonts etc.
478 * @param[in] fontDescription A font description.
479 * @param[out] fontList A list of the fonts which are a close match for fontDescription.
480 * @param[out] characterSetList A list of the character sets which are a close match for fontDescription.
482 void SetFontList( const FontDescription& fontDescription, FontList& fontList, CharacterSetList& characterSetList );
485 * Caches a font path.
487 * @param[in] ftFace The FreeType face.
488 * @param[in] id The font identifier.
489 * @param[in] requestedPointSize The font point size.
490 * @param[in] path Path to the font file name.
492 void CacheFontPath( FT_Face ftFace, FontId id, PointSize26Dot6 requestedPointSize, const FontPath& path );
495 * @brief Creates a character set from a given font's @p description.
497 * @param[in] description The font's description.
499 * @return A character set.
501 _FcCharSet* CreateCharacterSetFromDescription( const FontDescription& description );
504 * @brief Destroy all matched Patterns.
507 void DestroyMatchedPatterns();
511 // Declared private and left undefined to avoid copies.
512 Plugin( const Plugin& );
513 // Declared private and left undefined to avoid copies.
514 Plugin& operator=( const Plugin& );
518 FT_Library mFreeTypeLibrary; ///< A handle to a FreeType library instance.
520 unsigned int mDpiHorizontal; ///< Horizontal dpi.
521 unsigned int mDpiVertical; ///< Vertical dpi.
523 FontDescription mDefaultFontDescription; ///< The cached default font from the system
525 FontList mSystemFonts; ///< Cached system fonts.
526 FontList mDefaultFonts; ///< Cached default fonts.
527 CharacterSetList mDefaultFontCharacterSets;
529 std::vector<FallbackCacheItem> mFallbackCache; ///< Cached fallback font lists.
531 std::vector<FontFaceCacheItem> mFontFaceCache; ///< Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
532 std::vector<FontDescriptionCacheItem> mValidatedFontCache; ///< Caches indices to the vector of font descriptions for a given font.
533 FontList mFontDescriptionCache; ///< Caches font descriptions for the validated font.
534 CharacterSetList mCharacterSetCache; ///< Caches character set lists for the validated font.
535 std::vector<FontDescriptionSizeCacheItem> mFontDescriptionSizeCache; ///< Caches font identifiers for the pairs of font point size and the index to the vector with font descriptions of the validated fonts.
537 VectorFontCache* mVectorFontCache; ///< Separate cache for vector data blobs etc.
538 Vector<EllipsisItem> mEllipsisCache; ///< Caches ellipsis glyphs for a particular point size.
539 Vector<_FcPattern*> mMatchedFcPatternCache; ///< Contain matched FcPattern pointer.
541 bool mDefaultFontDescriptionCached : 1; ///< Whether the default font is cached or not
544 } // namespace Internal
546 } // namespace TextAbstraction
550 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H