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