8a62eb68079ceeb8f8b9f04165f9c5b55cf2a429
[platform/core/uifw/dali-adaptor.git] / dali / internal / text / 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) 2018 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/text-abstraction/font-client-impl.h>
25
26 #ifdef ENABLE_VECTOR_BASED_TEXT_RENDERING
27 #include <dali/internal/text/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 #include FT_OUTLINE_H
37 #include FT_STROKER_H
38
39 // forward declarations of font config types.
40 struct _FcCharSet;
41 struct _FcFontSet;
42 struct _FcPattern;
43
44 namespace Dali
45 {
46
47 namespace TextAbstraction
48 {
49
50 namespace Internal
51 {
52
53 /**
54  *@brief Type used for indices addressing the vector with front descriptions of validated fonts.
55  */
56 typedef uint32_t FontDescriptionId;
57 typedef Vector<_FcCharSet*> CharacterSetList;
58
59 /**
60  * @brief FontClient implementation.
61  */
62 struct FontClient::Plugin
63 {
64   /**
65    * @brief Caches an list of fallback fonts for a given font-description
66    */
67   struct FallbackCacheItem
68   {
69     FallbackCacheItem( FontDescription&& fontDescription, FontList* fallbackFonts, CharacterSetList* characterSets );
70
71     FontDescription fontDescription; ///< The font description.
72     FontList* fallbackFonts;         ///< The list of fallback fonts for the given font-description.
73     CharacterSetList* characterSets; ///< The list of character sets for the given font-description.
74   };
75
76   /**
77    * @brief Caches an index to the vector of font descriptions for a given font.
78    */
79   struct FontDescriptionCacheItem
80   {
81     FontDescriptionCacheItem( const FontDescription& fontDescription,
82                               FontDescriptionId index );
83     FontDescriptionCacheItem( FontDescription&& fontDescription,
84                               FontDescriptionId index );
85
86     FontDescription fontDescription; ///< The font description.
87     FontDescriptionId index;         ///< Index to the vector of font descriptions.
88   };
89
90   /**
91    * @brief Caches the font id of the pair font point size and the index to the vector of font descriptions of validated fonts.
92    */
93   struct FontDescriptionSizeCacheItem
94   {
95     FontDescriptionSizeCacheItem( FontDescriptionId validatedFontId,
96                                   PointSize26Dot6 requestedPointSize,
97                                   FontId fontId );
98
99     FontDescriptionId validatedFontId;    ///< Index to the vector with font descriptions.
100     PointSize26Dot6   requestedPointSize; ///< The font point size.
101     FontId            fontId;             ///< The font identifier.
102   };
103
104   /**
105    * @brief Caches the FreeType face and font metrics of the triplet 'path to the font file name, font point size and face index'.
106    */
107   struct FontFaceCacheItem
108   {
109     FontFaceCacheItem( FT_Face ftFace,
110                        const FontPath& path,
111                        PointSize26Dot6 requestedPointSize,
112                        FaceIndex face,
113                        const FontMetrics& metrics );
114
115     FontFaceCacheItem( FT_Face ftFace,
116                        const FontPath& path,
117                        PointSize26Dot6 requestedPointSize,
118                        FaceIndex face,
119                        const FontMetrics& metrics,
120                        float fixedWidth,
121                        float fixedHeight,
122                        bool hasColorTables );
123
124     FT_Face mFreeTypeFace;               ///< The FreeType face.
125     FontPath mPath;                      ///< The path to the font file name.
126     PointSize26Dot6 mRequestedPointSize; ///< The font point size.
127     FaceIndex mFaceIndex;                ///< The face index.
128     FontMetrics mMetrics;                ///< The font metrics.
129     _FcCharSet* mCharacterSet;           ///< Pointer with the range of characters.
130     FT_Short mFixedWidthPixels;          ///< The height in pixels (fixed size bitmaps only)
131     FT_Short mFixedHeightPixels;         ///< The height in pixels (fixed size bitmaps only)
132     unsigned int mVectorFontId;          ///< The ID of the equivalent vector-based font
133     bool mIsFixedSizeBitmap : 1;         ///< Whether the font has fixed size bitmaps.
134     bool mHasColorTables    : 1;         ///< Whether the font has color tables.
135   };
136
137   struct EllipsisItem
138   {
139     PointSize26Dot6 requestedPointSize;
140     GlyphInfo glyph;
141   };
142
143   /**
144    * Constructor.
145    *
146    * Initializes the FreeType library.
147    * Initializes the dpi values.
148    *
149    * @param[in] horizontalDpi The horizontal dpi.
150    * @param[in] verticalDpi The vertical dpi.
151    */
152   Plugin( unsigned int horizontalDpi, unsigned int verticalDpi );
153
154   /**
155    * Default destructor.
156    *
157    * Frees any allocated resource.
158    */
159   ~Plugin();
160
161   /**
162    * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
163    */
164   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
165
166   /**
167    * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
168    */
169   void ResetSystemDefaults();
170
171   /**
172    * @copydoc Dali::TextAbstraction::FontClient::SetDefaultFont()
173    */
174   void SetDefaultFont( const FontDescription& preferredFontDescription );
175
176   /**
177    * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
178    */
179   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
180
181   /**
182    * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
183    */
184   void GetDefaultFonts( FontList& defaultFonts );
185
186   /**
187    * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
188    */
189   void GetSystemFonts( FontList& systemFonts );
190
191   /**
192    * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
193    */
194   void GetDescription( FontId id, FontDescription& fontDescription ) const;
195
196   /**
197    * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
198    */
199   PointSize26Dot6 GetPointSize( FontId id );
200
201   /**
202    * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
203    */
204   bool IsCharacterSupportedByFont( FontId fontId, Character character );
205
206   /**
207    * @brief Finds within the @p fontList a font which support the @p carcode.
208    *
209    * @param[in] fontList A list of font paths, family, width, weight and slant.
210    * @param[in] characterSetList A list that contains a character set for each description of the font list.
211    * @param[in] charcode The character for which a font is needed.
212    * @param[in] requestedPointSize The point size in 26.6 fractional points.
213    * @param[in] preferColor @e true if a color font is preferred.
214    *
215    * @return A valid font identifier, or zero if no font is found.
216    */
217   FontId FindFontForCharacter( const FontList& fontList,
218                                const CharacterSetList& characterSetList,
219                                Character charcode,
220                                PointSize26Dot6 requestedPointSize,
221                                bool preferColor );
222
223   /**
224    * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
225    */
226   FontId FindDefaultFont( Character charcode,
227                           PointSize26Dot6 requestedPointSize,
228                           bool preferColor );
229
230   /**
231    * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
232    */
233   FontId FindFallbackFont( Character charcode,
234                            const FontDescription& preferredFontDescription,
235                            PointSize26Dot6 requestedPointSize,
236                            bool preferColor );
237
238   /**
239    * @see Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
240    *
241    * @param[in] cacheDescription Whether to cache the font description.
242    */
243   FontId GetFontId( const FontPath& path,
244                     PointSize26Dot6 requestedPointSize,
245                     FaceIndex faceIndex,
246                     bool cacheDescription );
247
248   /**
249    * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& preferredFontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
250    */
251   FontId GetFontId( const FontDescription& fontDescription,
252                     PointSize26Dot6 requestedPointSize,
253                     FaceIndex faceIndex );
254
255   /**
256    * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
257    */
258   bool IsScalable( const FontPath& path );
259
260   /**
261    * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
262    */
263   bool IsScalable( const FontDescription& fontDescription );
264
265   /**
266    * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
267    */
268   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
269
270   /**
271    * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
272    */
273   void GetFixedSizes( const FontDescription& fontDescription,
274                       Dali::Vector< PointSize26Dot6 >& sizes );
275
276   /**
277    * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
278    */
279   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
280
281   /**
282    * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
283    */
284   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
285
286   /**
287    * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
288    */
289   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal );
290
291   /**
292    * Helper for GetGlyphMetrics when using bitmaps
293    */
294   bool GetBitmapMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
295
296   /**
297    * Helper for GetGlyphMetrics when using vectors
298    */
299   bool GetVectorMetrics( GlyphInfo* array, uint32_t size, bool horizontal );
300
301   /**
302    * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
303    */
304   void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth );
305
306   /**
307    * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
308    */
309   PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
310
311   /**
312    * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
313    */
314   void CreateVectorBlob( FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight );
315
316   /**
317    * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
318    */
319   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
320
321   /**
322    * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
323    */
324   bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
325
326   /**
327    * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
328    */
329   bool AddCustomFontDirectory( const FontPath& path );
330
331 private:
332
333   /**
334    * @brief Caches the fonts present in the platform.
335    *
336    * Calls GetFcFontSet() to retrieve the fonts.
337    */
338   void InitSystemFonts();
339
340   /**
341    * @brief Gets the FontDescription which matches the given pattern.
342    * @param[in] pattern pattern to match against.
343    * @param[out] fontDescription the resultant fontDescription that matched.
344    * @param[out] characterSet The character set for that pattern.
345    * @return true if match found.
346    */
347   bool MatchFontDescriptionToPattern( _FcPattern* pattern, Dali::TextAbstraction::FontDescription& fontDescription, _FcCharSet** characterSet );
348
349   /**
350    * @brief Creates a font family pattern used to match fonts.
351    *
352    * @param[in] fontDescription The font to cache.
353    *
354    * @return The pattern.
355    */
356   _FcPattern* CreateFontFamilyPattern( const FontDescription& fontDescription ) const;
357
358   /**
359    * Retrieves the fonts present in the platform.
360    *
361    * @return A font fonfig data structure with the platform's fonts.
362    */
363   _FcFontSet* GetFcFontSet() const;
364
365   /**
366    * Retrieves a font config object's value from a pattern.
367    *
368    * @param[in] pattern The font config pattern.
369    * @param[in] n The object.
370    * @param[out] string The object's value.
371    *
372    * @return @e true if the operation is successful.
373    */
374   bool GetFcString( const _FcPattern* const pattern, const char* const n, std::string& string );
375
376   /**
377    * Retrieves a font config object's value from a pattern.
378    *
379    * @param[in] pattern The font config pattern.
380    * @param[in] n The object.
381    * @param[out] intVal The object's value.
382    *
383    * @return @e true if the operation is successful.
384    */
385   bool GetFcInt( const _FcPattern* const pattern, const char* const n, int& intVal );
386
387   /**
388    * @brief Creates a font.
389    *
390    * @param[in] path The path to the font file name.
391    * @param[in] requestedPointSize The requested point size.
392    * @param[in] faceIndex A face index.
393    * @param[in] cacheDescription Whether to cache the font description.
394    *
395    * @return The font identifier.
396    */
397   FontId CreateFont( const FontPath& path,
398                      PointSize26Dot6 requestedPointSize,
399                      FaceIndex faceIndex,
400                      bool cacheDescription );
401
402   /**
403    * @brief Copy the FreeType bitmap to the given buffer.
404    *
405    * @param[out] data The bitmap data.
406    * @param[in] srcBitmap The FreeType bitmap.
407    */
408   void ConvertBitmap( TextAbstraction::FontClient::GlyphBufferData& data, FT_Bitmap srcBitmap );
409
410   /**
411    * @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.
412    * If there is one , if writes the font identifier in the param @p fontId.
413    *
414    * @param[in] path Path to the font file name.
415    * @param[in] requestedPointSize The font point size.
416    * @param[in] faceIndex The face index.
417    * @param[out] fontId The font identifier.
418    *
419    * @return @e true if there triplet is found.
420    */
421   bool FindFont( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex, FontId& fontId ) const;
422
423   /**
424    * @brief Finds in the cache a cluster 'font family, font width, font weight, font slant'
425    * If there is one, it writes the index to the vector with font descriptions in the param @p validatedFontId.
426    *
427    * @param[in] fontDescription The font to validate.
428    * @param[out] validatedFontId The index to the vector with font descriptions.
429    *
430    * @return @e true if the pair is found.
431    */
432   bool FindValidatedFont( const FontDescription& fontDescription,
433                           FontDescriptionId& validatedFontId );
434
435   /**
436    * @brief Finds a fallback font list from the cache for a given font-description
437    *
438    * @param[in] fontDescription The font to validate.
439    * @param[out] A valid pointer to a font list, or @e nullptr if not found.
440    * @param[out] characterSetList A valid pointer to a character set list, or @e nullptr if not found.
441    */
442   bool FindFallbackFontList( const FontDescription& fontDescription,
443                              FontList*& fontList,
444                              CharacterSetList*& characterSetList );
445
446   /**
447    * @brief Finds in the cache a pair 'validated font identifier and font point size'.
448    * If there is one it writes the font identifier in the param @p fontId.
449    *
450    * @param[in] validatedFontId Index to the vector with font descriptions.
451    * @param[in] requestedPointSize The font point size.
452    * @param[out] fontId The font identifier.
453    *
454    * @return @e true if the pair is found.
455    */
456   bool FindFont( FontDescriptionId validatedFontId,
457                  PointSize26Dot6 requestedPointSize,
458                  FontId& fontId );
459
460   /**
461    * @brief Validate a font description.
462    *
463    * @param[in] fontDescription The font to validate.
464    * @param[out] validatedFontId Result of validation
465    */
466   void ValidateFont( const FontDescription& fontDescription,
467                      FontDescriptionId& validatedFontId );
468
469   /**
470    * Helper for GetDefaultFonts etc.
471    *
472    * @param[in] fontDescription A font description.
473    * @param[out] fontList A list of the fonts which are a close match for fontDescription.
474    * @param[out] characterSetList A list of the character sets which are a close match for fontDescription.
475    */
476   void SetFontList( const FontDescription& fontDescription, FontList& fontList, CharacterSetList& characterSetList );
477
478   /**
479    * Caches a font path.
480    *
481    * @param[in] ftFace The FreeType face.
482    * @param[in] id The font identifier.
483    * @param[in] requestedPointSize The font point size.
484    * @param[in] path Path to the font file name.
485    */
486   void CacheFontPath( FT_Face ftFace, FontId id, PointSize26Dot6 requestedPointSize,  const FontPath& path );
487
488   /**
489    * @brief Creates a character set from a given font's @p description.
490    *
491    * @param[in] description The font's description.
492    *
493    * @return A character set.
494    */
495   _FcCharSet* CreateCharacterSetFromDescription( const FontDescription& description );
496
497   /**
498    * @brief Destroy all matched Patterns.
499    *
500    */
501   void DestroyMatchedPatterns();
502
503 private:
504
505   // Declared private and left undefined to avoid copies.
506   Plugin( const Plugin& );
507   // Declared private and left undefined to avoid copies.
508   Plugin& operator=( const Plugin& );
509
510 private:
511
512   FT_Library mFreeTypeLibrary; ///< A handle to a FreeType library instance.
513
514   unsigned int mDpiHorizontal; ///< Horizontal dpi.
515   unsigned int mDpiVertical;   ///< Vertical dpi.
516
517   FontDescription mDefaultFontDescription; ///< The cached default font from the system
518
519   FontList mSystemFonts;       ///< Cached system fonts.
520   FontList mDefaultFonts;      ///< Cached default fonts.
521   CharacterSetList mDefaultFontCharacterSets;
522
523   std::vector<FallbackCacheItem> mFallbackCache; ///< Cached fallback font lists.
524
525   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'.
526   std::vector<FontDescriptionCacheItem>     mValidatedFontCache;       ///< Caches indices to the vector of font descriptions for a given font.
527   FontList                                  mFontDescriptionCache;     ///< Caches font descriptions for the validated font.
528   CharacterSetList                          mCharacterSetCache;        ///< Caches character set lists for the validated font.
529   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.
530
531   VectorFontCache* mVectorFontCache;            ///< Separate cache for vector data blobs etc.
532   Vector<EllipsisItem> mEllipsisCache;          ///< Caches ellipsis glyphs for a particular point size.
533   Vector<_FcPattern*>  mMatchedFcPatternCache;  ///< Contain matched FcPattern pointer.
534
535   bool mDefaultFontDescriptionCached : 1; ///< Whether the default font is cached or not
536 };
537
538 } // namespace Internal
539
540 } // namespace TextAbstraction
541
542 } // namespace Dali
543
544 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_PLUGIN_IMPL_H