Check supported by font and find fallback font for common script.
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / multi-language-support-impl.cpp
old mode 100644 (file)
new mode 100755 (executable)
index 750fab7..4b6eee2
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -67,38 +67,45 @@ FontId DefaultFonts::FindFont( TextAbstraction::FontClient& fontClient,
                                const TextAbstraction::FontDescription& description,
                                PointSize26Dot6 size ) const
 {
-  for( Vector<FontId>::ConstIterator it = mFonts.Begin(),
-         endIt = mFonts.End();
+  for( std::vector<CacheItem>::const_iterator it = mFonts.begin(),
+         endIt = mFonts.end();
        it != endIt;
        ++it )
   {
-    const FontId fontId = *it;
-    TextAbstraction::FontDescription fontDescription;
-    fontClient.GetDescription( fontId, fontDescription );
-
-    if( ( size == fontClient.GetPointSize( fontId ) ) &&
-        ( description.weight == fontDescription.weight ) &&
-        ( description.width == fontDescription.width ) &&
-        ( description.slant == fontDescription.slant ) )
+    const CacheItem& item = *it;
+
+    if( ( ( TextAbstraction::FontWeight::NONE == description.weight ) || ( description.weight == item.description.weight ) ) &&
+        ( ( TextAbstraction::FontWidth::NONE == description.width )   || ( description.width == item.description.width ) ) &&
+        ( ( TextAbstraction::FontSlant::NONE == description.slant )   || ( description.slant == item.description.slant ) ) &&
+        ( size == fontClient.GetPointSize( item.fontId ) ) &&
+        ( description.family.empty() || ( description.family == item.description.family ) ) )
     {
-      return fontId;
+      return item.fontId;
     }
   }
 
   return 0u;
 }
 
+void DefaultFonts::Cache( const TextAbstraction::FontDescription& description, FontId fontId )
+{
+  CacheItem item;
+  item.description = description;
+  item.fontId = fontId;
+  mFonts.push_back( item );
+}
+
 MultilanguageSupport::MultilanguageSupport()
 : mDefaultFontPerScriptCache(),
   mValidFontsPerScriptCache()
 {
   // Initializes the default font cache to zero (invalid font).
   // Reserves space to cache the default fonts and access them with the script as an index.
-  mDefaultFontPerScriptCache.Resize( TextAbstraction::UNKNOWN, NULL );
+  mDefaultFontPerScriptCache.Resize( TextAbstraction::UNKNOWN + 1, NULL );
 
   // Initializes the valid fonts cache to NULL (no valid fonts).
   // Reserves space to cache the valid fonts and access them with the script as an index.
-  mValidFontsPerScriptCache.Resize( TextAbstraction::UNKNOWN, NULL );
+  mValidFontsPerScriptCache.Resize( TextAbstraction::UNKNOWN + 1, NULL );
 }
 
 MultilanguageSupport::~MultilanguageSupport()
@@ -247,10 +254,6 @@ void MultilanguageSupport::SetScripts( const Vector<Character>& text,
         currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
 
         // Store the script run.
-        if( TextAbstraction::UNKNOWN == currentScriptRun.script )
-        {
-          currentScriptRun.script = TextAbstraction::LATIN;
-        }
         scripts.Insert( scripts.Begin() + scriptIndex, currentScriptRun );
         ++scriptIndex;
 
@@ -313,7 +316,6 @@ void MultilanguageSupport::SetScripts( const Vector<Character>& text,
       else if( ( TextAbstraction::UNKNOWN == currentScriptRun.script ) &&
                ( TextAbstraction::EMOJI == script ) )
       {
-        currentScriptRun.script = TextAbstraction::LATIN;
         currentScriptRun.characterRun.numberOfCharacters += numberOfAllScriptCharacters;
         numberOfAllScriptCharacters = 0u;
       }
@@ -350,12 +352,6 @@ void MultilanguageSupport::SetScripts( const Vector<Character>& text,
 
   if( 0u != currentScriptRun.characterRun.numberOfCharacters )
   {
-    if( TextAbstraction::UNKNOWN == currentScriptRun.script )
-    {
-      // There are only white spaces in the last script. Set the latin script.
-      currentScriptRun.script = TextAbstraction::LATIN;
-    }
-
     // Store the last run.
     scripts.Insert( scripts.Begin() + scriptIndex, currentScriptRun );
     ++scriptIndex;
@@ -440,20 +436,20 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
   Vector<ScriptRun>::ConstIterator scriptRunEndIt = scripts.End();
   bool isNewParagraphCharacter = false;
 
-  FontId currentFontId = 0u;
-  FontId previousFontId = 0u;
   bool isPreviousEmojiScript = false;
 
-  // Whether it's the first set of characters to be validated.
-  // Used in case the paragraph starts with characters common to all scripts.
-  bool isFirstSetToBeValidated = true;
+  // Description of fallback font which is selected at current iteration.
+  TextAbstraction::FontDescription selectedFontDescription;
 
   CharacterIndex lastCharacter = startIndex + numberOfCharacters;
   for( Length index = startIndex; index < lastCharacter; ++index )
   {
     // Get the current character.
     const Character character = *( textBuffer + index );
+    bool needSoftwareBoldening = false;
+    bool needSoftwareItalic = false;
 
+    // new description for current character
     TextAbstraction::FontDescription currentFontDescription;
     TextAbstraction::PointSize26Dot6 currentFontPointSize = defaultFontPointSize;
     bool isDefaultFont = true;
@@ -467,12 +463,11 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
 
     // Get the font for the current character.
     FontId fontId = fontClient.GetFontId( currentFontDescription, currentFontPointSize );
-    currentFontId = fontId;
 
     // Get the script for the current character.
-    const Script script = GetScript( index,
-                                     scriptRunIt,
-                                     scriptRunEndIt );
+    Script script = GetScript( index,
+                               scriptRunIt,
+                               scriptRunEndIt );
 
 #ifdef DEBUG_ENABLED
     {
@@ -493,10 +488,11 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
 
     // Check first in the cache of default fonts per script and size.
 
-    DefaultFonts* defaultFonts = *( defaultFontPerScriptCacheBuffer + script );
     FontId cachedDefaultFontId = 0u;
+    DefaultFonts* defaultFonts = *( defaultFontPerScriptCacheBuffer + script );
     if( NULL != defaultFonts )
     {
+      // This cache stores fall-back fonts.
       cachedDefaultFontId = defaultFonts->FindFont( fontClient,
                                                     currentFontDescription,
                                                     currentFontPointSize );
@@ -508,6 +504,12 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
     // The font is valid if it matches with the default one for the current script and size and it's different than zero.
     isValidFont = isValidCachedDefaultFont && ( fontId == cachedDefaultFontId );
 
+    if( isValidFont )
+    {
+      // Check if the font supports the character.
+      isValidFont = fontClient.IsCharacterSupportedByFont( fontId, character );
+    }
+
     bool isCommonScript = false;
     bool isEmojiScript = TextAbstraction::EMOJI == script;
 
@@ -526,7 +528,6 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
       currentFontRun.fontId = fontId;
     }
 
-
     // If the given font is not valid, it means either:
     // - there is no cached font for the current script yet or,
     // - the user has set a different font than the default one for the current script or,
@@ -549,101 +550,92 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
       //      supports the 'white space'. However, that font may not support the DEVANAGARI script.
       isCommonScript = TextAbstraction::IsCommonScript( character );
 
-      if( isCommonScript )
+      // Check in the valid fonts cache.
+      ValidateFontsPerScript* validateFontsPerScript = *( validFontsPerScriptCacheBuffer + script );
+
+      if( NULL != validateFontsPerScript )
       {
-        if( isValidCachedDefaultFont &&
-            ( isDefaultFont || ( currentFontId == previousFontId ) ) &&
-            !isEmojiScript )
+        // This cache stores valid fonts set by the user.
+        isValidFont = validateFontsPerScript->IsValidFont( fontId );
+
+        // It may happen that a validated font for a script doesn't have all the glyphs for that script.
+        // i.e a font validated for the CJK script may contain glyphs for the chinese language but not for the Japanese.
+        if( isValidFont )
         {
-          // At this point the character common for all scripts has no font assigned.
-          // If there is a valid previously cached default font for it, use that one.
-          fontId = cachedDefaultFontId;
-          isValidFont = true;
+          // Checks if the current character is supported by the font is needed.
+          isValidFont = fontClient.IsCharacterSupportedByFont( fontId, character );
         }
       }
-      else
+
+      if( !isValidFont ) // (2)
       {
-        // Check in the valid fonts cache.
-        ValidateFontsPerScript* validateFontsPerScript = *( validFontsPerScriptCacheBuffer + script );
+        // The selected font is not stored in any cache.
 
-        if( NULL != validateFontsPerScript )
-        {
-          isValidFont = validateFontsPerScript->IsValidFont( fontId );
-        }
+        // Checks if the current character is supported by the selected font.
+        isValidFont = fontClient.IsCharacterSupportedByFont( fontId, character );
 
-        if( !isValidFont ) // (2)
+        // Emojis are present in many monochrome fonts; prefer color by default.
+        if( isValidFont &&
+            isEmojiScript )
         {
-          // Use the font client to validate the font.
           const GlyphIndex glyphIndex = fontClient.GetGlyphIndex( fontId, character );
 
-          // The font is valid if there is a glyph for that character.
-          isValidFont = 0u != glyphIndex;
+          // For color emojis, the font is valid if the glyph is a color glyph (the bitmap is RGBA).
+          isValidFont = fontClient.IsColorGlyph( fontId, glyphIndex );
+        }
 
-          // Emojis are present in many monochrome fonts; prefer color by default.
-          if( isValidFont &&
-              isEmojiScript )
+        // If there is a valid font, cache it.
+        if( isValidFont && !isCommonScript )
+        {
+          if( NULL == validateFontsPerScript )
           {
-            const PixelData bitmap = fontClient.CreateBitmap( fontId, glyphIndex );
+            validateFontsPerScript = new ValidateFontsPerScript();
 
-            // For color emojis, the font is valid if the bitmap is RGBA.
-            isValidFont = bitmap && ( Pixel::BGRA8888 == bitmap.GetPixelFormat() );
+            *( validFontsPerScriptCacheBuffer + script ) = validateFontsPerScript;
           }
 
-          // If there is a valid font, cache it.
-          if( isValidFont )
-          {
-            if( NULL == validateFontsPerScript )
-            {
-              validateFontsPerScript = new ValidateFontsPerScript();
+          validateFontsPerScript->mValidFonts.PushBack( fontId );
+        }
 
-              *( validFontsPerScriptCacheBuffer + script ) = validateFontsPerScript;
-            }
+        if( !isValidFont && ( fontId != cachedDefaultFontId ) && ( !TextAbstraction::IsNewParagraph( character ) )) // (3)
+        {
+          // The selected font by the user or the platform's default font has failed to validate the character.
 
-            validateFontsPerScript->mValidFonts.PushBack( fontId );
+          // Checks if the previously discarted cached default font supports the character.
+          bool isValidCachedFont = false;
+          if( isValidCachedDefaultFont )
+          {
+            isValidCachedFont = fontClient.IsCharacterSupportedByFont( cachedDefaultFontId, character );
           }
 
-          if( !isValidFont ) // (3)
+          if( isValidCachedFont )
           {
-            // The given font has not been validated.
-
-            if( isValidCachedDefaultFont )
-            {
-              // Use the cached default font for the script if there is one.
-              fontId = cachedDefaultFontId;
-            }
-            else
-            {
-              // There is no valid cached default font for the script.
-
-              DefaultFonts* defaultFontsPerScript = NULL;
+            // Use the cached default font for the script if there is one.
+            fontId = cachedDefaultFontId;
+          }
+          else
+          {
+            // There is no valid cached default font for the script.
 
-              // Emojis are present in many monochrome fonts; prefer color by default.
-              const bool preferColor = ( TextAbstraction::EMOJI == script );
+            DefaultFonts* defaultFontsPerScript = NULL;
 
-              // Find a fallback-font.
-              fontId = fontClient.FindFallbackFont( character,
-                                                    currentFontDescription,
-                                                    currentFontPointSize,
-                                                    preferColor );
+            // Emojis are present in many monochrome fonts; prefer color by default.
+            const bool preferColor = ( TextAbstraction::EMOJI == script );
 
-              if( 0u == fontId )
-              {
-                // If the system does not support a suitable font, fallback to Latin
-                defaultFontsPerScript = *( defaultFontPerScriptCacheBuffer + TextAbstraction::LATIN );
-                if( NULL != defaultFontsPerScript )
-                {
-                  fontId = defaultFontsPerScript->FindFont( fontClient,
-                                                            currentFontDescription,
-                                                            currentFontPointSize );
-                }
-              }
+            // Find a fallback-font.
+            fontId = fontClient.FindFallbackFont( character,
+                                                  currentFontDescription,
+                                                  currentFontPointSize,
+                                                  preferColor );
 
-              if( 0u == fontId )
-              {
-                fontId = fontClient.FindDefaultFont( UTF32_A, currentFontPointSize );
-              }
+            if( 0u == fontId )
+            {
+              fontId = fontClient.FindDefaultFont( UTF32_A, currentFontPointSize );
+            }
 
-              // Cache the font.
+            if ( !isCommonScript && (script != TextAbstraction::UNKNOWN) )
+            {
+              // Cache the font if it is not an unknown script
               if( NULL == defaultFontsPerScript )
               {
                 defaultFontsPerScript = *( defaultFontPerScriptCacheBuffer + script );
@@ -654,11 +646,11 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
                   *( defaultFontPerScriptCacheBuffer + script ) = defaultFontsPerScript;
                 }
               }
-              defaultFontsPerScript->mFonts.PushBack( fontId );
+              defaultFontsPerScript->Cache( currentFontDescription, fontId );
             }
-          } // !isValidFont (3)
-        } // !isValidFont (2)
-      } // !isCommonScript
+          }
+        } // !isValidFont (3)
+      } // !isValidFont (2)
     } // !isValidFont (1)
 
 #ifdef DEBUG_ENABLED
@@ -674,15 +666,22 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
     }
 #endif
 
-    if( isFirstSetToBeValidated && !isCommonScript )
+    if( fontId != currentFontRun.fontId )
     {
-      currentFontRun.fontId = fontId;
-      isFirstSetToBeValidated = false;
+      fontClient.GetDescription(fontId,selectedFontDescription);
     }
 
+    // Developer sets bold to character but selected font cannot support it
+    needSoftwareBoldening = ( currentFontDescription.weight >= TextAbstraction::FontWeight::BOLD ) && ( selectedFontDescription.weight < TextAbstraction::FontWeight::BOLD );
+
+    // Developer sets italic to character but selected font cannot support it
+    needSoftwareItalic = ( currentFontDescription.slant == TextAbstraction::FontSlant::ITALIC ) && ( selectedFontDescription.slant < TextAbstraction::FontSlant::ITALIC );
+
     // The font is now validated.
     if( ( fontId != currentFontRun.fontId ) ||
-        isNewParagraphCharacter )
+        isNewParagraphCharacter ||
+        // If font id is same as previous but style is diffrent, initialize new one
+        ( ( fontId == currentFontRun.fontId ) && ( ( needSoftwareBoldening != currentFontRun.softwareBold ) || ( needSoftwareItalic != currentFontRun.softwareItalic ) ) ) )
     {
       // Current run needs to be stored and a new one initialized.
 
@@ -697,11 +696,8 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
       currentFontRun.characterRun.characterIndex = currentFontRun.characterRun.characterIndex + currentFontRun.characterRun.numberOfCharacters;
       currentFontRun.characterRun.numberOfCharacters = 0u;
       currentFontRun.fontId = fontId;
-
-      if( isNewParagraphCharacter )
-      {
-        isFirstSetToBeValidated = true;
-      }
+      currentFontRun.softwareItalic = needSoftwareItalic;
+      currentFontRun.softwareBold = needSoftwareBoldening;
     }
 
     // Add one more character to the run.
@@ -709,7 +705,6 @@ void MultilanguageSupport::ValidateFonts( const Vector<Character>& text,
 
     // Whether the current character is a new paragraph character.
     isNewParagraphCharacter = TextAbstraction::IsNewParagraph( character );
-    previousFontId = currentFontId;
     isPreviousEmojiScript = isEmojiScript;
   } // end traverse characters.