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) 2015 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/object/base-handle.h>
  25 #include <dali/devel-api/text-abstraction/font-list.h>
  26 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace TextAbstraction
  32 {
  33
  34 struct FontMetrics;
  35 struct GlyphInfo;
  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_IMPORT_API FontClient : public BaseHandle
  62 {
  63 public:
  64   static const PointSize26Dot6 DEFAULT_POINT_SIZE; ///< The default point size.
  65
  66 public:
  67
  68   /**
  69    * @brief Retrieve a handle to the FontClient instance.
  70    *
  71    * @return A handle to the FontClient
  72    */
  73   static FontClient Get();
  74
  75   /**
  76    * @brief Create an uninitialized TextAbstraction handle.
  77    */
  78   FontClient();
  79
  80   /**
  81    * @brief Destructor
  82    *
  83    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  84    */
  85   ~FontClient();
  86
  87   /**
  88    * @brief This copy constructor is required for (smart) pointer semantics.
  89    *
  90    * @param[in] handle A reference to the copied handle.
  91    */
  92   FontClient( const FontClient& handle );
  93
  94   /**
  95    * @brief This assignment operator is required for (smart) pointer semantics.
  96    *
  97    * @param [in] handle  A reference to the copied handle.
  98    * @return A reference to this.
  99    */
 100   FontClient& operator=( const FontClient& handle );
 101
 102   ////////////////////////////////////////
 103   // Font management and validation.
 104   ////////////////////////////////////////
 105
 106   /**
 107    * @brief Set the DPI of the target window.
 108    *
 109    * @note Multiple windows are not currently supported.
 110    * @param[in] horizontalDpi The horizontal resolution in DPI.
 111    * @param[in] verticalDpi The vertical resolution in DPI.
 112    */
 113   void SetDpi( unsigned int horizontalDpi, unsigned int verticalDpi );
 114
 115   /**
 116    * @brief Retrieves the DPI previously set to the target window.
 117    *
 118    * @note Multiple windows are not currently supported.
 119    * @param[out] horizontalDpi The horizontal resolution in DPI.
 120    * @param[out] verticalDpi The vertical resolution in DPI.
 121    */
 122   void GetDpi( unsigned int& horizontalDpi, unsigned int& verticalDpi );
 123
 124   /**
 125    * Set the default font family and its style that should be used by the font client.
 126    *
 127    * @param[in] fontFamilyName The default name of the font's family.
 128    * @param[in] fontStyle The default font's style.
 129    */
 130   void SetDefaultFontFamily( const std::string& fontFamilyName,
 131                              const std::string& fontStyle );
 132
 133   /**
 134    * @brief Retrieve the list of default fonts supported by the system.
 135    *
 136    * @param[out] defaultFonts A list of default font paths, family & style strings.
 137    */
 138   void GetDefaultFonts( FontList& defaultFonts );
 139
 140   /**
 141    * @brief Retrieve the list of fonts supported by the system.
 142    *
 143    * @param[out] systemFonts A list of font paths, family & style strings.
 144    */
 145   void GetSystemFonts( FontList& systemFonts );
 146
 147   /**
 148    * @brief Retrieves the font description of a given font @p id.
 149    *
 150    * @param[in] id The font id.
 151    * @param[out] fontDescription The path, family & style describing the font.
 152    */
 153   void GetDescription( FontId id, FontDescription& fontDescription );
 154
 155   /**
 156    * @brief Retrieves the font point size of a given font @p id.
 157    *
 158    * @param[in] id The font id.
 159    *
 160    * @return The point size in 26.6 fractional points.
 161    */
 162   PointSize26Dot6 GetPointSize( FontId id );
 163
 164   /**
 165    * @brief Find an appropriate font for displaying a UTF-32 character.
 166    *
 167    * This is useful when localised strings are provided for multiple languages
 168    * i.e. when a single default font does not work for all languages.
 169    * @param[in] charcode The character for which a font is needed.
 170    * @param[in] pointSize The point size in 26.6 fractional points; the default point size is 12*64.
 171    * @param[in] preferColor True if a color font is preferred.
 172    * @return A valid font ID, or zero if the font does not exist.
 173    */
 174   FontId FindDefaultFont( Character charcode,
 175                           PointSize26Dot6 pointSize = DEFAULT_POINT_SIZE,
 176                           bool preferColor = false );
 177
 178   /**
 179    * @brief Retrieve the unique identifier for a font.
 180    *
 181    * @param[in] path The path to a font file.
 182    * @param[in] pointSize The point size in 26.6 fractional points; the default point size is 12*64.
 183    * @param[in] faceIndex The index of the font face (optional).
 184    * @return A valid font ID, or zero if the font does not exist.
 185    */
 186   FontId GetFontId( const FontPath& path, PointSize26Dot6 pointSize = DEFAULT_POINT_SIZE, FaceIndex faceIndex = 0 );
 187
 188   /**
 189    * @brief Retrieve the unique identifier for a font.
 190    *
 191    * @param[in] fontFamily The font family name.
 192    * @param[in] fontStyle  The font style.
 193    * @param[in] pointSize The point size in 26.6 fractional points; the default point size is 12*64.
 194    * @param[in] faceIndex The index of the font face (optional).
 195    * @return A valid font ID, or zero if the font does not exist.
 196    */
 197   FontId GetFontId( const FontFamily& fontFamily,
 198                     const FontStyle& fontStyle,
 199                     PointSize26Dot6 pointSize = DEFAULT_POINT_SIZE,
 200                     FaceIndex faceIndex = 0 );
 201
 202   /**
 203    * @brief Check to see if a font is scalable.
 204    *
 205    * @param[in] path The path to a font file.
 206    * @return true if scalable.
 207    */
 208   bool IsScalable( const FontPath& path );
 209
 210   /**
 211    * @brief Check to see if a font is scalable.
 212    *
 213    * @param[in] fontFamily The font family name.
 214    * @param[in] style The font style.
 215    * @return true if scalable
 216    */
 217   bool IsScalable( const FontFamily& fontFamily, const FontStyle& style );
 218
 219   /**
 220    * @brief Get a list of sizes available for a fixed size font.
 221    *
 222    * @param[in] path The path to a font file.
 223    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 224    */
 225   void GetFixedSizes( const FontPath& path, Dali::Vector< PointSize26Dot6>& sizes );
 226
 227   /**
 228    * @brief Get a list of sizes available for a fixed size font.
 229    *
 230    * @param[in] fontFamily The font family name.
 231    * @param[in] style The font style.
 232    * @param[out] sizes A list of the available sizes, if no sizes available will return empty.
 233    */
 234   void GetFixedSizes( const FontFamily& fontFamily,
 235                       const FontStyle& style,
 236                       Dali::Vector< PointSize26Dot6 >& sizes );
 237
 238   ////////////////////////////////////////
 239   // Font metrics, glyphs and bitmaps.
 240   ////////////////////////////////////////
 241
 242   /**
 243    * @brief Query the metrics for a font.
 244    *
 245    * @param[in] fontId The ID of the font for the required glyph.
 246    * @param[out] metrics The font metrics.
 247    */
 248   void GetFontMetrics( FontId fontId, FontMetrics& metrics );
 249
 250   /**
 251    * @brief Retrieve the glyph index for a UTF-32 character code.
 252    *
 253    * @param[in] fontId The ID of the font for the required glyph.
 254    * @param[in] charcode The UTF-32 character code.
 255    * @return The glyph index, or zero if the character code is undefined.
 256    */
 257   GlyphIndex GetGlyphIndex( FontId fontId, Character charcode );
 258
 259   /**
 260    * @brief Retrieve the metrics for a series of glyphs.
 261    *
 262    * @param[in,out] array An array of glyph-info structures with initialized FontId & GlyphIndex values.
 263    * It may contain the advance and an offset set into the bearing from the shaping tool.
 264    * 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.
 265    * @param[in] size The size of the array.
 266    * @param[in] horizontal True for horizontal layouts (set to false for vertical layouting).
 267    * @return True if all of the requested metrics were found.
 268    */
 269   bool GetGlyphMetrics( GlyphInfo* array, uint32_t size, bool horizontal = true );
 270
 271   /**
 272    * @brief Render a bitmap representation of a glyph.
 273    *
 274    * @param[in] fontId The ID of the font.
 275    * @param[in] glyphIndex The index of a glyph within the specified font.
 276    * @return A valid BufferImage, or an empty handle if the glyph could not be rendered.
 277    */
 278   BufferImage CreateBitmap( FontId fontId, GlyphIndex glyphIndex );
 279
 280   /**
 281    * @brief Retrieves the ellipsis glyph for a requested point size.
 282    *
 283    * @param[in] pointSize The requested point size.
 284    *
 285    * @return The ellipsis glyph.
 286    */
 287   const GlyphInfo& GetEllipsisGlyph( PointSize26Dot6 pointSize );
 288
 289 public: // Not intended for application developers
 290   /**
 291    * @brief This constructor is used by FontClient::Get().
 292    *
 293    * @param[in] fontClient  A pointer to the internal fontClient object.
 294    */
 295   explicit DALI_INTERNAL FontClient( Internal::FontClient* fontClient );
 296 };
 297
 298 } // namespace TextAbstraction
 299
 300 } // namespace Dali
 301
 302 #endif // __DALI_PLATFORM_TEXT_ABSTRACTION_FONT_CLIENT_H__