text/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) 2017 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
  29 namespace Dali
  30 {
  31
  32 namespace TextAbstraction
  33 {
  34
  35 struct FontMetrics;
  36 struct GlyphInfo;
  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_IMPORT_API FontClient : public BaseHandle
  63 {
  64 public:
  65   static const PointSize26Dot6 DEFAULT_POINT_SIZE; ///< The default point size.
  66
  67   /**
  68    * @brief Struct used to retrieve the glyph's bitmap.
  69    */
  70   struct GlyphBufferData
  71   {
  72     /**
  73      * @brief Constructor.
  74      *
  75      * Initializes struct members to their defaults.
  76      */
  77     GlyphBufferData();
  78
  79     /**
  80      * @brief Destructor.
  81      */
  82     ~GlyphBufferData();
  83
  84     unsigned char* buffer; ///< The glyph's bitmap buffer data.
  85     unsigned int   width;  ///< The width of the bitmap.
  86     unsigned int   height; ///< The height of the bitmap.
  87     Pixel::Format  format; ///< The pixel's format of the bitmap.
  88   };
  89
  90 public:
  91
  92   /**
  93    * @brief Retrieve a handle to the FontClient instance.
  94    *
  95    * @return A handle to the FontClient
  96    */
  97   static FontClient Get();
  98
  99   /**
 100    * @brief Create an uninitialized TextAbstraction handle.
 101    */
 102   FontClient();
 103
 104   /**
 105    * @brief Destructor
 106    *
 107    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 108    */
 109   ~FontClient();
 110
 111   /**
 112    * @brief This copy constructor is required for (smart) pointer semantics.
 113    *
 114    * @param[in] handle A reference to the copied handle.
 115    */
 116   FontClient( const FontClient& handle );
 117
 118   /**
 119    * @brief This assignment operator is required for (smart) pointer semantics.
 120    *
 121    * @param [in] handle  A reference to the copied handle.
 122    * @return A reference to this.
 123    */
 124   FontClient& operator=( const FontClient& handle );
 125
 126   ////////////////////////////////////////
 127   // Font management and validation.
 128   ////////////////////////////////////////
 129
 130   /**
 131    * @brief Clear all caches in FontClient
 132    *
 133    */
 134   void ClearCache();
 135
 136   /**
 137    * @brief Set the DPI of the target window.
 138    *
 139    * @note Multiple windows are not currently supported.
 140    * @param[in] horizontalDpi The horizontal resolution in DPI.
 141    * @param[in] verticalDpi The vertical resolution in DPI.
 142    */
 143   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 144
 145   /**
 146    * @brief Retrieves the DPI previously set to the target window.
 147    *
 148    * @note Multiple windows are not currently supported.
 149    * @param[out] horizontalDpi The horizontal resolution in DPI.
 150    * @param[out] verticalDpi The vertical resolution in DPI.
 151    */
 152   void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
 153
 154   /**
 155    * @brief Called by Dali to retrieve the default font size for the platform.
 156    *
 157    * This is an accessibility size, which is mapped to a UI Control specific point-size in stylesheets.
 158    * For example if zero the smallest size, this could potentially map to TextLabel point-size 8.
 159    * @return The default font size.
 160    */
 161   int GetDefaultFontSize();
 162
 163   /**
 164    * @brief Called when the user changes the system defaults.
 165    *
 166    * @post Previously cached system defaults are removed.
 167    */
 168   void ResetSystemDefaults();
 169
 170   /**
 171    * @brief Retrieve the list of default fonts supported by the system.
 172    *
 173    * @param[out] defaultFonts A list of default font paths, family, width, weight and slant.
 174    */
 175   void GetDefaultFonts( FontList& defaultFonts );
 176
 177   /**
 178    * @brief Retrieve the active default font from the system.
 179    *
 180    * @param[out] fontDescription font structure describing the default font.
 181    */
 182   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
 183
 184   /**
 185    * @brief Retrieve the list of fonts supported by the system.
 186    *
 187    * @param[out] systemFonts A list of font paths, family, width, weight and slant.
 188    */
 189   void GetSystemFonts( FontList& systemFonts );
 190
 191   /**
 192    * @brief Retrieves the font description of a given font @p id.
 193    *
 194    * @param[in] id The font identifier.
 195    * @param[out] fontDescription The path, family & style (width, weight and slant) describing the font.
 196    */
 197   void GetDescription( FontId id, FontDescription& fontDescription );
 198
 199   /**
 200    * @brief Retrieves the font point size of a given font @p id.
 201    *
 202    * @param[in] id The font identifier.
 203    *
 204    * @return The point size in 26.6 fractional points.
 205    */
 206   PointSize26Dot6 GetPointSize( FontId id );
 207
 208   /**
 209    * @brief Whether the given @p character is supported by the font.
 210    *
 211    * @param[in] fontId The id of the font.
 212    * @param[in] character The character.
 213    *
 214    * @return @e true if the character is supported by the font.
 215    */
 216   bool IsCharacterSupportedByFont( FontId fontId, Character character );
 217
 218   /**
 219    * @brief Find the default font for displaying a UTF-32 character.
 220    *
 221    * This is useful when localised strings are provided for multiple languages
 222    * i.e. when a single default font does not work for all languages.
 223    *
 224    * @param[in] charcode The character for which a font is needed.
 225    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 226    * @param[in] preferColor @e true if a color font is preferred.
 227    *
 228    * @return A valid font identifier, or zero if the font does not exist.
 229    */
 230   FontId FindDefaultFont( Character charcode,
 231                           PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 232                           bool preferColor = false );
 233
 234   /**
 235    * @brief Find a fallback-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] preferredFontDescription Description of the preferred font which may not provide a glyph for @p charcode.
 242    *                                     The fallback-font will be the closest match to @p preferredFontDescription, which does support the required glyph.
 243    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 244    * @param[in] preferColor @e true if a color font is preferred.
 245    *
 246    * @return A valid font identifier, or zero if the font does not exist.
 247    */
 248   FontId FindFallbackFont( Character charcode,
 249                            const FontDescription& preferredFontDescription,
 250                            PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 251                            bool preferColor = false );
 252
 253   /**
 254    * @brief Retrieve the unique identifier for a font.
 255    *
 256    * @param[in] path The path to a font file.
 257    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 258    * @param[in] faceIndex The index of the font face (optional).
 259    *
 260    * @return A valid font identifier, or zero if the font does not exist.
 261    */
 262   FontId GetFontId( const FontPath& path,
 263                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 264                     FaceIndex faceIndex = 0 );
 265
 266   /**
 267    * @brief Retrieves a unique font identifier for a given description.
 268    *
 269    * @param[in] preferredFontDescription Description of the preferred font.
 270    *                                     The font will be the closest match to @p preferredFontDescription.
 271    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 272    * @param[in] faceIndex The index of the font face (optional).
 273    *
 274    * @return A valid font identifier, or zero if no font is found.
 275    */
 276   FontId GetFontId( const FontDescription& preferredFontDescription,
 277                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 278                     FaceIndex faceIndex = 0 );
 279
 280   /**
 281    * @brief Check to see if a font is scalable.
 282    *
 283    * @param[in] path The path to a font file.
 284    * @return true if scalable.
 285    */
 286   bool IsScalable( const FontPath& path );
 287
 288   /**
 289    * @brief Check to see if a font is scalable.
 290    *
 291    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 292    *
 293    * @param[in] fontDescription A font description.
 294    *
 295    * @return true if scalable
 296    */
 297   bool IsScalable( const FontDescription& fontDescription );
 298
 299   /**
 300    * @brief Get a list of sizes available for a fixed size font.
 301    *
 302    * @param[in] path The path to a font file.
 303    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 304    */
 305   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
 306
 307   /**
 308    * @brief Get a list of sizes available for a fixed size font.
 309    *
 310    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 311    *
 312    * @param[in] fontDescription A font description.
 313    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 314    */
 315   void GetFixedSizes( const FontDescription& fontDescription,
 316                       Dali::Vector< PointSize26Dot6 >& sizes );
 317
 318   ////////////////////////////////////////
 319   // Font metrics, glyphs and bitmaps.
 320   ////////////////////////////////////////
 321
 322   /**
 323    * @brief Query the metrics for a font.
 324    *
 325    * @param[in] fontId The identifier of the font for the required glyph.
 326    * @param[out] metrics The font metrics.
 327    */
 328   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
 329
 330   /**
 331    * @brief Retrieve the glyph index for a UTF-32 character code.
 332    *
 333    * @param[in] fontId The identifier of the font for the required glyph.
 334    * @param[in] charcode The UTF-32 character code.
 335    *
 336    * @return The glyph index, or zero if the character code is undefined.
 337    */
 338   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 339
 340   /**
 341    * @brief Retrieve the metrics for a series of glyphs.
 342    *
 343    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 344    *                      It may contain the advance and an offset set into the bearing from the shaping tool.
 345    *                      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.
 346    * @param[in] size The size of the array.
 347    * @param[in] type The type of glyphs used for rendering; either bitmaps or vectors.
 348    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 349    *
 350    * @return @e true if all of the requested metrics were found.
 351    */
 352   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true );
 353
 354   /**
 355    * @brief Create a bitmap representation of a glyph.
 356    *
 357    * @note The caller is responsible for deallocating the bitmap data @p data.buffer using delete[].
 358    *
 359    * @param[in]  fontId          The identifier of the font.
 360    * @param[in]  glyphIndex      The index of a glyph within the specified font.
 361    * @param[in]  softwareItalic  Whether glyph needs software support to draw italic style.
 362    * @param[in]  softwareBold    Whether glyph needs software support to draw bold style.
 363    * @param[out] data            The bitmap data.
 364    * @param[in]  outlineWidth    The width of the glyph outline in pixels.
 365    */
 366   void CreateBitmap( FontId fontId, GlyphIndex glyphIndex, bool softwareItalic, bool softwareBold, GlyphBufferData& data, int outlineWidth );
 367
 368   /**
 369    * @brief Create a bitmap representation of a glyph.
 370    *
 371    * @param[in] fontId The identifier of the font.
 372    * @param[in] glyphIndex The index of a glyph within the specified font.
 373    * @param[in] outlineWidth The width of the glyph outline in pixels.
 374    *
 375    * @return A valid BufferImage, or an empty handle if the glyph could not be rendered.
 376    */
 377   PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex, int outlineWidth );
 378
 379   /**
 380    * @brief Create a vector representation of a glyph.
 381    *
 382    * @note This feature requires highp shader support and is not available on all platforms
 383    * @param[in] fontId The identifier of the font.
 384    * @param[in] glyphIndex The index of a glyph within the specified font.
 385    * @param[out] blob A blob of data; this is owned by FontClient and should be copied by the caller of CreateVectorData().
 386    * @param[out] blobLength The length of the blob data, or zero if the blob creation failed.
 387    * @param[out] nominalWidth The width of the blob.
 388    * @param[out] nominalHeight The height of the blob.
 389    */
 390   void CreateVectorBlob( FontId fontId,
 391                          GlyphIndex glyphIndex,
 392                          VectorBlob*& blob,
 393                          unsigned int& blobLength,
 394                          unsigned int& nominalWidth,
 395                          unsigned int& nominalHeight );
 396
 397   /**
 398    * @brief Retrieves the ellipsis glyph for a requested point size.
 399    *
 400    * @param[in] requestedPointSize The requested point size.
 401    *
 402    * @return The ellipsis glyph.
 403    */
 404   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
 405
 406   /**
 407    * @brief Whether the given glyph @p glyphIndex is a color glyph.
 408    *
 409    * @param[in] fontId The font id.
 410    * @param[in] glyphIndex The glyph index.
 411    *
 412    * @return @e true if the glyph is a color one.
 413    */
 414   bool IsColorGlyph( FontId fontId, GlyphIndex glyphIndex );
 415
 416   /**
 417    * @brief  Add custom fonts directory
 418    *
 419    * @param[in] path to the fonts directory
 420    *
 421    * @return true if the fonts can be added.
 422    */
 423   bool AddCustomFontDirectory( const FontPath& path );
 424
 425 public: // Not intended for application developers
 426   /**
 427    * @brief This constructor is used by FontClient::Get().
 428    *
 429    * @param[in] fontClient  A pointer to the internal fontClient object.
 430    */
 431   explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient );
 432 };
 433
 434 } // namespace TextAbstraction
 435
 436 } // namespace Dali
 437
 438 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H