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