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) 2016 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 public:
  68
  69   /**
  70    * @brief Retrieve a handle to the FontClient instance.
  71    *
  72    * @return A handle to the FontClient
  73    */
  74   static FontClient Get();
  75
  76   /**
  77    * @brief Create an uninitialized TextAbstraction handle.
  78    */
  79   FontClient();
  80
  81   /**
  82    * @brief Destructor
  83    *
  84    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  85    */
  86   ~FontClient();
  87
  88   /**
  89    * @brief This copy constructor is required for (smart) pointer semantics.
  90    *
  91    * @param[in] handle A reference to the copied handle.
  92    */
  93   FontClient( const FontClient& handle );
  94
  95   /**
  96    * @brief This assignment operator is required for (smart) pointer semantics.
  97    *
  98    * @param [in] handle  A reference to the copied handle.
  99    * @return A reference to this.
 100    */
 101   FontClient& operator=( const FontClient& handle );
 102
 103   ////////////////////////////////////////
 104   // Font management and validation.
 105   ////////////////////////////////////////
 106
 107   /**
 108    * @brief Set the DPI of the target window.
 109    *
 110    * @note Multiple windows are not currently supported.
 111    * @param[in] horizontalDpi The horizontal resolution in DPI.
 112    * @param[in] verticalDpi The vertical resolution in DPI.
 113    */
 114   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 115
 116   /**
 117    * @brief Retrieves the DPI previously set to the target window.
 118    *
 119    * @note Multiple windows are not currently supported.
 120    * @param[out] horizontalDpi The horizontal resolution in DPI.
 121    * @param[out] verticalDpi The vertical resolution in DPI.
 122    */
 123   void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
 124
 125   /**
 126    * @brief Called when the user changes the system defaults.
 127    *
 128    * @post Previously cached system defaults are removed.
 129    */
 130   void ResetSystemDefaults();
 131
 132   /**
 133    * @brief Retrieve the list of default fonts supported by the system.
 134    *
 135    * @param[out] defaultFonts A list of default font paths, family & style strings.
 136    */
 137   void GetDefaultFonts( FontList& defaultFonts );
 138
 139   /**
 140    * @brief Retrieve the active default font from the system
 141    *
 142    * @param[out] fontDescription font structure describing the default font
 143    */
 144   void GetDefaultPlatformFontDescription( FontDescription& fontDescription );
 145
 146   /**
 147    * @brief Retrieve the list of fonts supported by the system.
 148    *
 149    * @param[out] systemFonts A list of font paths, family & style strings.
 150    */
 151   void GetSystemFonts( FontList& systemFonts );
 152
 153   /**
 154    * @brief Retrieves the font description of a given font @p id.
 155    *
 156    * @param[in] id The font id.
 157    * @param[out] fontDescription The path, family & style describing the font.
 158    */
 159   void GetDescription( FontId id, FontDescription& fontDescription );
 160
 161   /**
 162    * @brief Retrieves the font point size of a given font @p id.
 163    *
 164    * @param[in] id The font id.
 165    *
 166    * @return The point size in 26.6 fractional points.
 167    */
 168   PointSize26Dot6 GetPointSize( FontId id );
 169
 170   /**
 171    * @brief Find the default font for displaying a UTF-32 character.
 172    *
 173    * This is useful when localised strings are provided for multiple languages
 174    * i.e. when a single default font does not work for all languages.
 175    * @param[in] charcode The character for which a font is needed.
 176    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 177    * @param[in] preferColor True if a color font is preferred.
 178    * @return A valid font ID, or zero if the font does not exist.
 179    */
 180   FontId FindDefaultFont( Character charcode,
 181                           PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 182                           bool preferColor = false );
 183
 184   /**
 185    * @brief Find a fallback-font for displaying a UTF-32 character.
 186    *
 187    * This is useful when localised strings are provided for multiple languages
 188    * i.e. when a single default font does not work for all languages.
 189    * @param[in] preferredFont The preferred font which may not provide a glyph for charcode.
 190    * The fallback-font will be the closest match to preferredFont, which does support the required glyph.
 191    * @param[in] charcode The character for which a font is needed.
 192    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 193    * @param[in] preferColor True if a color font is preferred.
 194    * @return A valid font ID, or zero if the font does not exist.
 195    */
 196   FontId FindFallbackFont( FontId preferredFont,
 197                            Character charcode,
 198                            PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 199                            bool preferColor = false );
 200
 201   /**
 202    * @brief Retrieve the unique identifier for a font.
 203    *
 204    * @param[in] path The path to a font file.
 205    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 206    * @param[in] faceIndex The index of the font face (optional).
 207    * @return A valid font ID, or zero if the font does not exist.
 208    */
 209   FontId GetFontId( const FontPath& path,
 210                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 211                     FaceIndex faceIndex = 0 );
 212
 213   /**
 214    * @brief Retrieve the unique identifier for a font.
 215    *
 216    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 217    *
 218    * @param[in] fontDescription A font description.
 219    * @param[in] requestedPointSize The point size in 26.6 fractional points; the default point size is 12*64.
 220    * @param[in] faceIndex The index of the font face (optional).
 221    * @return A valid font ID, or zero if the font does not exist.
 222    */
 223   FontId GetFontId( const FontDescription& fontDescription,
 224                     PointSize26Dot6 requestedPointSize = DEFAULT_POINT_SIZE,
 225                     FaceIndex faceIndex = 0 );
 226
 227   /**
 228    * @brief Check to see if a font is scalable.
 229    *
 230    * @param[in] path The path to a font file.
 231    * @return true if scalable.
 232    */
 233   bool IsScalable( const FontPath& path );
 234
 235   /**
 236    * @brief Check to see if a font is scalable.
 237    *
 238    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 239    *
 240    * @param[in] fontDescription A font description.
 241    *
 242    * @return true if scalable
 243    */
 244   bool IsScalable( const FontDescription& fontDescription );
 245
 246   /**
 247    * @brief Get a list of sizes available for a fixed size font.
 248    *
 249    * @param[in] path The path to a font file.
 250    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 251    */
 252   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
 253
 254   /**
 255    * @brief Get a list of sizes available for a fixed size font.
 256    *
 257    * @note It the font style is not empty, it will be used instead the font weight and font slant slant.
 258    *
 259    * @param[in] fontDescription A font description.
 260    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 261    */
 262   void GetFixedSizes( const FontDescription& fontDescription,
 263                       Dali::Vector< PointSize26Dot6 >& sizes );
 264
 265   ////////////////////////////////////////
 266   // Font metrics, glyphs and bitmaps.
 267   ////////////////////////////////////////
 268
 269   /**
 270    * @brief Query the metrics for a font.
 271    *
 272    * @param[in] fontId The ID of the font for the required glyph.
 273    * @param[out] metrics The font metrics.
 274    */
 275   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
 276
 277   /**
 278    * @brief Retrieve the glyph index for a UTF-32 character code.
 279    *
 280    * @param[in] fontId The ID of the font for the required glyph.
 281    * @param[in] charcode The UTF-32 character code.
 282    * @return The glyph index, or zero if the character code is undefined.
 283    */
 284   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 285
 286   /**
 287    * @brief Retrieve the metrics for a series of glyphs.
 288    *
 289    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 290    * It may contain the advance and an offset set into the bearing from the shaping tool.
 291    * 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.
 292    * @param[in] size The size of the array.
 293    * @param[in] type The type of glyphs used for rendering; either bitmaps or vectors.
 294    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 295    * @return True if all of the requested metrics were found.
 296    */
 297   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, GlyphType type, bool horizontal = true );
 298
 299   /**
 300    * @brief Create a bitmap representation of a glyph.
 301    *
 302    * @param[in] fontId The ID of the font.
 303    * @param[in] glyphIndex The index of a glyph within the specified font.
 304    * @return A valid BufferImage, or an empty handle if the glyph could not be rendered.
 305    */
 306   PixelData CreateBitmap( FontId fontId, GlyphIndex glyphIndex );
 307
 308   /**
 309    * @brief Create a vector representation of a glyph.
 310    *
 311    * @note This feature requires highp shader support and is not available on all platforms
 312    * @param[in] fontId The ID of the font.
 313    * @param[in] glyphIndex The index of a glyph within the specified font.
 314    * @param[out] blob A blob of data; this is owned by FontClient and should be copied by the caller of CreateVectorData().
 315    * @param[out] blobLength The length of the blob data, or zero if the blob creation failed.
 316    * @param[out] nominalWidth The width of the blob.
 317    * @param[out] nominalHeight The height of the blob.
 318    */
 319   void CreateVectorBlob( FontId fontId,
 320                          GlyphIndex glyphIndex,
 321                          VectorBlob*& blob,
 322                          unsigned int& blobLength,
 323                          unsigned int& nominalWidth,
 324                          unsigned int& nominalHeight );
 325
 326   /**
 327    * @brief Retrieves the ellipsis glyph for a requested point size.
 328    *
 329    * @param[in] requestedPointSize The requested point size.
 330    *
 331    * @return The ellipsis glyph.
 332    */
 333   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 requestedPointSize );
 334
 335 public: // Not intended for application developers
 336   /**
 337    * @brief This constructor is used by FontClient::Get().
 338    *
 339    * @param[in] fontClient  A pointer to the internal fontClient object.
 340    */
 341   explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient );
 342 };
 343
 344 } // namespace TextAbstraction
 345
 346 } // namespace Dali
 347
 348 #endif // DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H