dali/devel-api/text-abstraction/font-client.h

   1 #ifndef DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
   2 #define DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H
   3
   4 /*
   5  * Copyright (c) 2019 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/public-api/common/dali-vector.h>
  23 #include <dali/public-api/images/buffer-image.h>
  24 #include <dali/public-api/images/pixel-data.h>
  25 #include <dali/public-api/object/base-handle.h>
  26 #include <dali/devel-api/text-abstraction/font-list.h>
  27 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  28 #include <dali/public-api/dali-adaptor-common.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace TextAbstraction
  34 {
  35
  36 struct FontMetrics;
  37 struct GlyphInfo;
  38 struct BitmapFont;
  39
  40 namespace Internal DALI_INTERNAL
  41 {
  42 class FontClient;
  43 }
  44
  45 /**
  46  * @brief FontClient provides access to font information and resources.
  47  *
  48  * <h3>Querying the System Fonts</h3>
  49  *
  50  * A "system font" is described by a "path" to a font file on the native filesystem, along with a "family" and "style".
  51  * For example on the Ubuntu system a "Regular" style font from the "Ubuntu Mono" family can be accessed from "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf".
  52  *
  53  * <h3>Accessing Fonts</h3>
  54  *
  55  * A "font" is created from the system for a specific point size in 26.6 fractional points. A "FontId" is used to identify each font.
  56  * For example two different fonts with point sizes 10 & 12 can be created from the "Ubuntu Mono" family:
  57  * @code
  58  * FontClient fontClient   = FontClient::Get();
  59  * FontId ubuntuMonoTen    = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 10*64 );
  60  * FontId ubuntuMonoTwelve = fontClient.GetFontId( "/usr/share/fonts/truetype/ubuntu-font-family/UbuntuMono-R.ttf", 12*64 );
  61  * @endcode
  62  * Glyph metrics and bitmap resources can then be retrieved using the FontId.
  63  */
  64 class DALI_ADAPTOR_API FontClient : public BaseHandle
  65 {
  66 public:
  67   static const PointSize26Dot6 DEFAULT_POINT_SIZE; ///< The default point size.
  68   static const float DEFAULT_ITALIC_ANGLE;         ///< The default software italic angle in radians.
  69
  70   /**
  71    * @brief Struct used to retrieve the glyph's bitmap.
  72    */
  73   struct DALI_ADAPTOR_API GlyphBufferData
  74   {
  75     /**
  76      * @brief Constructor.
  77      *
  78      * Initializes struct members to their defaults.
  79      */
  80     GlyphBufferData();
  81
  82     /**
  83      * @brief Destructor.
  84      */
  85     ~GlyphBufferData();
  86
  87     unsigned char* buffer;          ///< The glyph's bitmap buffer data.
  88     unsigned int   width;           ///< The width of the bitmap.
  89     unsigned int   height;          ///< The height of the bitmap.
  90     Pixel::Format  format;          ///< The pixel's format of the bitmap.
  91     bool           isColorEmoji:1;  ///< Whether the glyph is an emoji.
  92     bool           isColorBitmap:1; ///< Whether the glyph is a color bitmap.
  93   };
  94
  95   /**
  96    * @brief Used to load an embedded item into the font client.
  97    */
  98   struct EmbeddedItemDescription
  99   {
 100     std::string       url;               ///< The url path of the image.
 101     unsigned int      width;             ///< The width of the item.
 102     unsigned int      height;            ///< The height of the item.
 103     ColorBlendingMode colorblendingMode; ///< Whether the color of the image is multiplied by the color of the text.
 104   };
 105
 106 public:
 107
 108   /**
 109    * @brief Retrieve a handle to the FontClient instance.
 110    *
 111    * @return A handle to the FontClient
 112    */
 113   static FontClient Get();
 114
 115   /**
 116    * @brief Create an uninitialized TextAbstraction handle.
 117    */
 118   FontClient();
 119
 120   /**
 121    * @brief Destructor
 122    *
 123    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 124    */
 125   ~FontClient();
 126
 127   /**
 128    * @brief This copy constructor is required for (smart) pointer semantics.
 129    *
 130    * @param[in] handle A reference to the copied handle.
 131    */
 132   FontClient( const FontClient& handle );
 133
 134   /**
 135    * @brief This assignment operator is required for (smart) pointer semantics.
 136    *
 137    * @param [in] handle  A reference to the copied handle.
 138    * @return A reference to this.
 139    */
 140   FontClient& operator=( const FontClient& handle );
 141
 142   ////////////////////////////////////////
 143   // Font management and validation.
 144   ////////////////////////////////////////
 145
 146   /**
 147    * @brief Clear all caches in FontClient
 148    *
 149    */
 150   void ClearCache();
 151
 152   /**
 153    * @brief Set the DPI of the target window.
 154    *
 155    * @note Multiple windows are not currently supported.
 156    * @param[in] horizontalDpi The horizontal resolution in DPI.
 157    * @param[in] verticalDpi The vertical resolution in DPI.
 158    */
 159   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 160
 161   /**
 162    * @brief Retrieves the DPI previously set to the target window.
 163    *
 164    * @note Multiple windows are not currently supported.
 165    * @param[out] horizontalDpi The horizontal resolution in DPI.
 166    * @param[out] verticalDpi The vertical resolution in DPI.
 167    */
 168   void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
 169
 170   /**
 171    * @brief Called by Dali to retrieve the default font size for the platform.
 172    *
 173    * This is an accessibility size, which is mapped to a UI Control specific point-size in stylesheets.
 174    * For example if zero the smallest size, this could potentially map to TextLabel point-size 8.
 175    * @return The default font size.
 176    */
 177   int GetDefaultFontSize();
 178
 179   /**
 180    * @brief Called when the user changes the system defaults.
 181    *
 182    * @post Previously cached system defaults are removed.
 183    */
 184   void ResetSystemDefaults();
 185
 186   /**
 187    * @brief Retrieve the list of default fonts supported by the system.
 188    *
 189    * @param[out] defaultFonts A list of default font paths, family, width, weight and slant.
 190    */
 191   void GetDefaultFonts( FontList& defaultFonts );
 192
 193   /**
 194    * @brief Retrieve the active default font from the system.
 195    *
 196    * @param[out] fontDescription font structure describing the default font.
 197    */
 198   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
 199
 200   /**
 201    * @brief Retrieve the list of fonts supported by the system.
 202    *
 203    * @param[out] systemFonts A list of font paths, family, width, weight and slant.
 204    */
 205   void GetSystemFonts( FontList& systemFonts );
 206
 207   /**
 208    * @brief Retrieves the font description of a given font @p id.
 209    *
 210    * @param[in] id The font identifier.
 211    * @param[out] fontDescription The path, family & style (width, weight and slant) describing the font.
 212    */
 213   void GetDescription( FontId id, FontDescription& fontDescription );
 214
 215   /**
 216    * @brief Retrieves the font point size of a given font @p id.
 217    *
 218    * @param[in] id The font identifier.
 219    *
 220    * @return The point size in 26.6 fractional points.
 221    */
 222   PointSize26Dot6 GetPointSize( FontId id );
 223
 224   /**
 225    * @brief Whether the given @p character is supported by the font.
 226    *
 227    * @param[in] fontId The id of the font.
 228    * @param[in] character The character.
 229    *
 230    * @return @e true if the character is supported by the font.
 231    */
 232   bool IsCharacterSupportedByFont( FontId fontId, Character character );
 233
 234   /**
 235    * @brief Find the default font for displaying a UTF-32 character.
 236    *
 237    * This is useful when localised strings are provided for multiple languages
 238    * i.e. when a single default font does not work for all languages.
 239    *
 240    * @param[in] charcode The character for which a font is needed.
 241    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 242    * @param[in] preferColor @e true if a color font is preferred.
 243    *
 244    * @return A valid font identifier, or zero if the font does not exist.
 245    */
 246   FontId FindDefaultFont( Character charcode,
 247                           PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 248                           bool preferColor = false );
 249
 250   /**
 251    * @brief Find a fallback-font for displaying a UTF-32 character.
 252    *
 253    * This is useful when localised strings are provided for multiple languages
 254    * i.e. when a single default font does not work for all languages.
 255    *
 256    * @param[in] charcode The character for which a font is needed.
 257    * @param[in] preferredFontDescription Description of the preferred font which may not provide a glyph for @p charcode.
 258    *                                     The fallback-font will be the closest match to @p preferredFontDescription, which does support the required glyph.
 259    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 260    * @param[in] preferColor @e true if a color font is preferred.
 261    *
 262    * @return A valid font identifier, or zero if the font does not exist.
 263    */
 264   FontId FindFallbackFont( Character charcode,
 265                            const FontDescription& preferredFontDescription,
 266                            PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 267                            bool preferColor = false );
 268
 269   /**
 270    * @brief Retrieve the unique identifier for a font.
 271    *
 272    * @param[in] path The path to a font file.
 273    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 274    * @param[in] faceIndex The index of the font face (optional).
 275    *
 276    * @return A valid font identifier, or zero if the font does not exist.
 277    */
 278   FontId GetFontId( const FontPath& path,
 279                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 280                     FaceIndex faceIndex = 0 );
 281
 282   /**
 283    * @brief Retrieves a unique font identifier for a given description.
 284    *
 285    * @param[in] preferredFontDescription Description of the preferred font.
 286    *                                     The font will be the closest match to @p preferredFontDescription.
 287    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 288    * @param[in] faceIndex The index of the font face (optional).
 289    *
 290    * @return A valid font identifier, or zero if no font is found.
 291    */
 292   FontId GetFontId( const FontDescription& preferredFontDescription,
 293                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 294                     FaceIndex faceIndex = 0 );
 295
 296   /**
 297    * @brief Retrieves a unique font identifier for a given bitmap font.
 298    *
 299    * @param[in] bitmapFont A bitmap font.
 300    *
 301    * @return A valid font identifier, or zero if no bitmap font is created.
 302    */
 303   FontId GetFontId( const BitmapFont& bitmapFont );
 304
 305   /**
 306    * @brief Check to see if a font is scalable.
 307    *
 308    * @param[in] path The path to a font file.
 309    * @return true if scalable.
 310    */
 311   bool IsScalable( const FontPath& path );
 312
 313   /**
 314    * @brief Check to see if a font is scalable.
 315    *
 316    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 317    *
 318    * @param[in] fontDescription A font description.
 319    *
 320    * @return true if scalable
 321    */
 322   bool IsScalable( const FontDescription& fontDescription );
 323
 324   /**
 325    * @brief Get a list of sizes available for a fixed size font.
 326    *
 327    * @param[in] path The path to a font file.
 328    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 329    */
 330   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
 331
 332   /**
 333    * @brief Get a list of sizes available for a fixed size font.
 334    *
 335    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 336    *
 337    * @param[in] fontDescription A font description.
 338    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 339    */
 340   void GetFixedSizes( const FontDescription& fontDescription,
 341                       Dali::Vector< PointSize26Dot6 >& sizes );
 342
 343   /**
 344    * @brief Whether the font has Italic style.
 345    *
 346    * @param[in] fontId The font identifier.
 347    *
 348    * @return true if the font has italic style.
 349    */
 350   bool HasItalicStyle( FontId fontId ) const;
 351
 352   ////////////////////////////////////////
 353   // Font metrics, glyphs and bitmaps.
 354   ////////////////////////////////////////
 355
 356   /**
 357    * @brief Query the metrics for a font.
 358    *
 359    * @param[in] fontId The identifier of the font for the required glyph.
 360    * @param[out] metrics The font metrics.
 361    */
 362   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
 363
 364   /**
 365    * @brief Retrieve the glyph index for a UTF-32 character code.
 366    *
 367    * @param[in] fontId The identifier of the font for the required glyph.
 368    * @param[in] charcode The UTF-32 character code.
 369    *
 370    * @return The glyph index, or zero if the character code is undefined.
 371    */
 372   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 373
 374   /**
 375    * @brief Retrieve the metrics for a series of glyphs.
 376    *
 377    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 378    *                      It may contain the advance and an offset set into the bearing from the shaping tool.
 379    *                      On return, the glyph's size value will be initialized. The bearing value will be updated by adding the font's glyph bearing to the one set by the shaping tool.
 380    * @param[in] size The size of the array.
 381    * @param[in] type The type of glyphs used for rendering; either bitmaps or vectors.
 382    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 383    *
 384    * @return @e true if all of the requested metrics were found.
 385    */
 386   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true );
 387
 388   /**
 389    * @brief Create a bitmap representation of a glyph.
 390    *
 391    * @note The caller is responsible for deallocating the bitmap data @p data.buffer using delete[].
 392    *
 393    * @param[in]  fontId           The identifier of the font.
 394    * @param[in]  glyphIndex       The index of a glyph within the specified font.
 395    * @param[in]  isItalicRequired Whether the glyph requires italic style.
 396    * @param[in]  isBoldRequired   Whether the glyph requires bold style.
 397    * @param[out] data             The bitmap data.
 398    * @param[in]  outlineWidth     The width of the glyph outline in pixels.
 399    */
 400   void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool isItalicRequired, bool isBoldRequired, GlyphBufferData& data, int outlineWidth );
 401
 402   /**
 403    * @brief Create a bitmap representation of a glyph.
 404    *
 405    * @param[in] fontId The identifier of the font.
 406    * @param[in] glyphIndex The index of a glyph within the specified font.
 407    * @param[in] outlineWidth The width of the glyph outline in pixels.
 408    *
 409    * @return A valid BufferImage, or an empty handle if the glyph could not be rendered.
 410    */
 411   PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
 412
 413   /**
 414    * @brief Create a vector representation of a glyph.
 415    *
 416    * @note This feature requires highp shader support and is not available on all platforms
 417    * @param[in] fontId The identifier of the font.
 418    * @param[in] glyphIndex The index of a glyph within the specified font.
 419    * @param[out] blob A blob of data; this is owned by FontClient and should be copied by the caller of CreateVectorData().
 420    * @param[out] blobLength The length of the blob data, or zero if the blob creation failed.
 421    * @param[out] nominalWidth The width of the blob.
 422    * @param[out] nominalHeight The height of the blob.
 423    */
 424   void CreateVectorBlob( FontId fontId,
 425                          GlyphIndex glyphIndex,
 426                          VectorBlob*& blob,
 427                          unsigned int& blobLength,
 428                          unsigned int& nominalWidth,
 429                          unsigned int& nominalHeight );
 430
 431   /**
 432    * @brief Retrieves the ellipsis glyph for a requested point size.
 433    *
 434    * @param[in] requestedPointSize The requested point size.
 435    *
 436    * @return The ellipsis glyph.
 437    */
 438   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
 439
 440   /**
 441    * @brief Whether the given glyph @p glyphIndex is a color glyph.
 442    *
 443    * @param[in] fontId The font id.
 444    * @param[in] glyphIndex The glyph index.
 445    *
 446    * @return @e true if the glyph is a color one.
 447    */
 448   bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
 449
 450   /**
 451    * @brief  Add custom fonts directory
 452    *
 453    * @param[in] path to the fonts directory
 454    *
 455    * @return true if the fonts can be added.
 456    */
 457   bool AddCustomFontDirectory( const FontPath& path );
 458
 459   /**
 460    * @brief Creates and stores an embedded item and it's metrics.
 461    *
 462    * If in the @p description there is a non empty url, it calls Dali::LoadImageFromFile() internally.
 463    * If in the @p description there is a url and @e width or @e height are zero it stores the default size. Otherwise the image is resized.
 464    * If the url in the @p description is empty it stores the size.
 465    *
 466    * @param[in] description The description of the embedded item.
 467    * @param[out] pixelFormat The pixel format of the image.
 468    *
 469    * return The index within the vector of embedded items.
 470    */
 471   GlyphIndex CreateEmbeddedItem( const EmbeddedItemDescription& description, Pixel::Format& pixelFormat);
 472
 473
 474 public: // Not intended for application developers
 475   /**
 476    * @brief This constructor is used by FontClient::Get().
 477    *
 478    * @param[in] fontClient  A pointer to the internal fontClient object.
 479    */
 480   explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient );
 481 };
 482
 483 } // namespace TextAbstraction
 484
 485 } // namespace Dali
 486
 487 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H