1 #ifndef DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H
2 #define DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H
5 * Copyright (c) 2019 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/public-api/object/base-object.h>
25 #include <dali/devel-api/text-abstraction/font-client.h>
33 namespace TextAbstraction
40 * Implementation of the FontClient
42 class FontClient : public BaseObject
57 * @copydoc Dali::TextAbstraction::FontClient::Get()
59 static Dali::TextAbstraction::FontClient Get();
62 * @brief This is used to improve application launch performance
64 * @return A pre-initialized FontClient
66 static Dali::TextAbstraction::FontClient PreInitialize();
69 * @copydoc Dali::TextAbstraction::FontClient::ClearCache()
74 * @copydoc Dali::TextAbstraction::FontClient::SetDpi()
76 void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
79 * @copydoc Dali::TextAbstraction::FontClient::GetDpi()
81 void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
84 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFontSize()
86 int GetDefaultFontSize();
89 * @copydoc Dali::TextAbstraction::FontClient::ResetSystemDefaults()
91 void ResetSystemDefaults();
94 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultFonts()
96 void GetDefaultFonts( FontList& defaultFonts );
99 * @copydoc Dali::TextAbstraction::FontClient::GetDefaultPlatformFontDescription()
101 void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
104 * @copydoc Dali::TextAbstraction::FontClient::GetSystemFonts()
106 void GetSystemFonts( FontList& systemFonts );
109 * @copydoc Dali::TextAbstraction::FontClient::GetDescription()
111 void GetDescription( FontId id, FontDescription& fontDescription );
114 * @copydoc Dali::TextAbstraction::FontClient::GetPointSize()
116 PointSize26Dot6 GetPointSize( FontId id );
119 * @copydoc Dali::TextAbstraction::FontClient::IsCharacterSupportedByFont()
121 bool IsCharacterSupportedByFont( FontId fontId, Character character );
124 * @copydoc Dali::TextAbstraction::FontClient::FindDefaultFont()
126 FontId FindDefaultFont( Character charcode,
127 PointSize26Dot6 requestedPointSize,
131 * @copydoc Dali::TextAbstraction::FontClient::FindFallbackFont()
133 FontId FindFallbackFont( Character charcode,
134 const FontDescription& preferredFontDescription,
135 PointSize26Dot6 requestedPointSize,
139 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
141 FontId GetFontId( const FontPath& path, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex );
144 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const FontDescription& fontDescription, PointSize26Dot6 requestedPointSize, FaceIndex faceIndex )
146 FontId GetFontId( const FontDescription& fontDescription,
147 PointSize26Dot6 requestedPointSize,
148 FaceIndex faceIndex );
151 * @copydoc Dali::TextAbstraction::FontClient::GetFontId( const BitmapFont& bitmapFont )
153 FontId GetFontId( const BitmapFont& bitmapFont );
156 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontPath& path )
158 bool IsScalable( const FontPath& path );
161 * @copydoc Dali::TextAbstraction::FontClient::IsScalable( const FontDescription& fontDescription )
163 bool IsScalable( const FontDescription& fontDescription );
166 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes )
168 void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
171 * @copydoc Dali::TextAbstraction::FontClient::GetFixedSizes()
173 void GetFixedSizes( const FontDescription& fontDescription,
174 Dali::Vector< PointSize26Dot6 >& sizes );
177 * @copydoc Dali::TextAbstraction::FontClient::HasItalicStyle()
179 bool HasItalicStyle( FontId fontId ) const;
182 * @copydoc Dali::TextAbstraction::FontClient::GetFontMetrics()
184 void GetFontMetrics( FontId fontId, FontMetrics& metrics );
187 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphIndex()
189 GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
192 * @copydoc Dali::TextAbstraction::FontClient::GetGlyphMetrics()
194 bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal );
197 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth )
199 void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, Dali::TextAbstraction::FontClient::GlyphBufferData& data, int outlineWidth );
202 * @copydoc Dali::TextAbstraction::FontClient::CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth )
204 PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
207 * @copydoc Dali::TextAbstraction::FontClient::CreateVectorBlob()
209 void CreateVectorBlob( FontId fontId, GlyphIndex glyphIndex, VectorBlob*& blob, unsigned int& blobLength, unsigned int& nominalWidth, unsigned int& nominalHeight );
212 * @copydoc Dali::TextAbstraction::FontClient::GetEllipsisGlyph()
214 const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
217 * @copydoc Dali::TextAbstraction::FontClient::IsColorGlyph()
219 bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
222 * @copydoc Dali::TextAbstraction::FontClient::CreateEmbeddedItem()
224 GlyphIndex CreateEmbeddedItem( const TextAbstraction::FontClient::EmbeddedItemDescription& description, Pixel::Format& pixelFormat );
227 * @brief Retrieves the pointer to the FreeType Font Face for the given @p fontId.
229 * @param[in] fontId The font id.
231 * @return The pointer to the FreeType Font Face.
233 FT_FaceRec_* GetFreetypeFace( FontId fontId );
236 * @brief Retrieves the type of font.
238 * @param[in] fontId The font id.
240 * @return FACE_FONT if the font has been loaded by FreeType, BITMAP_FONT if it's a font that has been loaded from images or INVALID if it's a non valid font.
242 FontDescription::Type GetFontType( FontId fontId );
245 * @copydoc Dali::TextAbstraction::FontClient::AddCustomFontDirectory()
247 bool AddCustomFontDirectory( const FontPath& path );
252 * Helper for lazy initialization.
256 // Undefined copy constructor.
257 FontClient( const FontClient& );
259 // Undefined assignment constructor.
260 FontClient& operator=( const FontClient& );
267 // Allows DPI to be set without loading plugin
268 unsigned int mDpiHorizontal;
269 unsigned int mDpiVertical;
271 static Dali::TextAbstraction::FontClient gPreInitializedFontClient;
273 }; // class FontClient
275 } // namespace Internal
277 inline static Internal::FontClient& GetImplementation(FontClient& fontClient)
279 DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
280 BaseObject& handle = fontClient.GetBaseObject();
281 return static_cast<Internal::FontClient&>(handle);
284 inline static const Internal::FontClient& GetImplementation(const FontClient& fontClient)
286 DALI_ASSERT_ALWAYS( fontClient && "fontClient handle is empty" );
287 const BaseObject& handle = fontClient.GetBaseObject();
288 return static_cast<const Internal::FontClient&>(handle);
291 } // namespace TextAbstraction
295 #endif // DALI_INTERNAL_TEXT_ABSTRACTION_FONT_CLIENT_IMPL_H